Get Started

Installation

1. Fork this repo
2. Clone your new repo into your local dev environment & cd into the new directory
3. Ensure you have the npm configs set globally for Font Awesome Pro, or that you have a .npmrc file with your Font Awesome Pro auth token (more info)
4. Run bundle install
5. Run yarn install
6. Copy .env.sample to .env (cp .env.sample .env)

Running the App

1. Run docker-compose up -d (dcup if you have the aliases below) to spin up Postgres & Redis
2. Run rails s to spin up the Rails server
3. Run ./bin/webpack-dev-server to spin up the Webpack Dev Server
4. Run bundle exec sidekiq to spin up Sidekiq if needed

Helpful Aliases

alias dcdown='docker-compose down'
alias dcps='docker-compose ps'
alias dcup='docker-compose up -d'