Jumpstart docs logo Back to the app

Installation

Installing Jumpstart Pro

To install dependencies, set up, and configure your application follow the latest instructions in the repository:

Rails Installation

iOS Installation

Android Installation

Screencast

This screencast will walk you through cloning Jumpstart Pro's git repository, installing dependencies, and setting up your brand new application so you can easily merge updates from git.

Development

Jumpstart Pro provides some useful configuration for making development easier.

Processes

Use the bin/dev command to run your application's processes.

As usual, you'll need to run several processes in development.

  • rails server - duh. 😜
  • yarn run build - bundles Javascript using esbuild
  • yarn run build:css - bundles CSS using Tailwind CLI and PostCSS
  • sidekiq - or whatever background worker process you have configured

These commands are defined in Procfile and Procfile.dev so they can be started and shutdown together.

You'll also need to make sure PostgreSQL, Redis, etc servers are installed and running externally.

Foreman & Overmind

Overmind and Foreman are process managers that start/stop the processes defined in Procfile.dev. Overmind is the recommended option because it uses tmux, allowing you to join a process and interact with it. Foreman is unable to do this which means you cannot use binding.irb or pry like normal unfortunately.

brew install tmux overmind
# or
# gem install foreman

You can then run your application anytime with:

bin/dev

Docker

If you'd like to use Docker, we provide a Dockerfile and docker-compose.yml example configuration you can use as a starting point.