Structure

The jets new command generates the initial folder structure for a Jets project. The structure looks like this:

.
├── app
│   ├── controllers
│   ├── helpers
│   ├── javascript
│   ├── jobs
│   ├── models
│   └── views
├── bin
├── config
├── db
├── public
└── spec

The table below covers the purpose of each:

File / Directory Description
app/controllers Contains controller code that handles API Gateway web requests. For more info refer to controllers
app/functions Contains simple functions. For more info refer to functions.
app/helpers Contains helpers methods that can be used to assist view code.
app/javascript Contains javascript, CSS and images files that webpacker compiles. The javascript files live in javascript/packs, the CSS in javascript/src and images in javascript/images. Refer to webpacker for more info.
app/jobs Contains job code. This code usually execute on a scheduled basis asynchronously outside of the request-response cycle. For more info refer to the jobs docs
app/models Contains model code, usually classes that interact with a database.
app/shared Contains shared resources. Refer to Shared Resources.
app/views Contains view code, usually HTML pages and forms.
bin Contains helper executables.
config Your application’s configurations. Where to configure the application’s settings, database, routes, webpacker settings, etc. Application-wide configurations are set in config/application.rb.
db Contains database migrations. The ActiveRecord migrations live under db/migrate and the Dynamodb migrations are under db/dynamodb.
public Contains static files meant to be served straight up.
spec Contains unit tests.

Pro tip: Use the <- and -> arrow keys to move back and forward.

Edit this page

See a typo or an error? You can improve this page. This website is available on GitHub and contributions are encouraged and welcomed. We love pull requests from you!