Ignore

Please note that your browser is not supported.

We recommend upgrading to the latest Firefox or Google Chrome.

Hello, Web: Installing Pakyow

Pakyow projects are developed locally and deployed to a server when it's time to show the project to others. In this guide we'll walk through getting a local development environment setup so you can get to building. Since Pakyow has few outside dependencies, this shouldn't take too long.

First, Pakyow needs a modern version of Ruby. To check if Ruby is already installed on your system, open a terminal and run this command:

ruby -v

If Ruby is installed, you should see output that looks like this:

ruby 2.6.3p62

Pakyow is compatible with Ruby 2.5 and later. If you have an older version of Ruby installed, or you're missing Ruby altogether, move on to Installing Ruby. Otherwise, run this command to install Pakyow:

gem install pakyow

If the command succeeds, you're ready to go!

Ruby & Pakyow installed? Next, generate your project.

Installing Ruby

If your system has an older version of Ruby—or Ruby isn't installed at all—this guide will help get you going. We've included instructions for the most popular operating systems below.

If you're running macOS:

  1. Install Homebrew (we'll wait here)
  2. Open a terminal and run this command:
brew install ruby

If you're running Linux:

Install Ruby with apt or yum depending on your distribution.

For Debian, Ubuntu, and Mint flavors, open a terminal and run this command:

sudo apt-get update && sudo apt-get install ruby

For CentOS, RedHat, and Fedora, open a terminal and run this command:

sudo yum install ruby

For anything else, we'll trust you know what to do.

If you're running Windows:

Ruby isn't quite as well supported on Windows, but it's still possible to setup a local development environment. We recommend using the RubyInstaller to install Ruby on Windows.


Once Ruby is installed on your system, run this command to install Pakyow:

gem install pakyow

If the command succeeds, you're ready to go!

Generating your project

Pakyow includes several command-line tasks for interacting with projects. Among them is the pakyow create task, which generates a shiny new project from a template with the most common conventions.

To generate a new project, open a terminal and run this command (just be sure to replace {project-name} with the name of your project):

pakyow create {project-name}

Once your project is generated, use the cd command to move into the project directory and run the pakyow boot task to boot the project:

cd {project-name} && pakyow boot

You should see output that looks like this:

162.01ms pkyw.de04ea20 | Pakyow › Development › http://localhost:3000
                       | Use Ctrl-C to shut down the environment.

You can access your project by navigating to localhost:3000 in a web browser.

Next Up: Project Structure