Please note that your browser is not supported.

We recommend upgrading to the latest Firefox or Google Chrome.

Hello, Web: Project Structure

Pakyow generates a complete project structure for you, following the conventions used by most projects. Using the defaults greatly reduces the decisions you have to make, helping you be more productive at the start.

Don't have a project yet? Learn how to generate one

Here's an overview of the structure you'll find in a default project:

File or Folder Overview
backend/ Ruby code that powers your project on the server, such as controllers.
frontend/ View templates and assets that make up the client-side parts of your project.
config/ Configuration files and initializers for your project.
database/ Migrations and other supporting files for your project's data sources.
lib/ General purpose Ruby code that doesn't quite fit within the backend.
public/ Static files you want to serve outside of the asset pipeline, such as robots.txt.
tasks/ Project tasks runnable through the command line interface.
spec/ The automated test suite for your project.
.env Configuration used to configure Pakyow for your development environment.
Gemfile Where your project's Ruby dependencies are defined.

You may not see all of these folders in a freshly generated project, but don't worry! Pakyow will generate them for you as needed.

Internal files & folders

You may also see some of the following files and folders in your project:

File or Folder Overview
bin/ Binstubs for running scripts in context of your project.
tmp/ Temporary files like caches.
Gemfile.lock Snapshot of your project's dependencies.
Procfile Defines the processes needed to run your project in production.

These are internal files for Pakyow and its dependencies. It's rare you'll ever need to touch these files, but leave them in place so things work properly.

Next Up: 5-Minute App