Getting Started

Hello! This documentation will guide you through all the major topics around building and deploying a Pakyow application. If you're looking for more of a crash course instead of a detailed guide, checkout the warmup.

Community

Software is changing the world, and we want to change how you build software. Our hope is to build an open, friendly, and helpful community around these ideas. We'd love to have you join us. All thoughts, ideas, and productive criticism is encouraged.

Get help and contribute your ideas on the mailing list.

Having trouble? Report a bug.

Browse the source on GitHub.

Follow along on Twitter.

Pakyow's GitHub Contributors

Installation

Pakyow is easy to install, but it relies on Ruby and RubyGems. Make sure those are installed first. Here are some links to point you in the right direction:

Once these are installed, open a terminal prompt and type:

gem install pakyow

Generation

From a terminal prompt, type:

pakyow new name_of_app

A new project will be generated in the 'name_of_app' directory.

Architecture

Here's a rundown of the important bits of a generated Pakyow app:

  • app.rb: app environment configuration
  • app/lib: all of your back-end code goes here (every .rb file will be loaded automatically)
  • app/lib/bindings.rb: define your bindings here
  • app/lib/helpers.rb: define your helpers here
  • app/lib/routes.rb: define your routes here
  • app/views: define your views here
  • public: for static files (images, stylesheets, javascripts, etc)