Lunar & Flo API

Documentation

View the API Blueprint or view the hosted docs.

Admin

We use Forest Admin to manage this application.

Develop

• Config

  • The following environment variables are available:
    • FORECAST_API_KEY - our API key for Forecast.io
    • FOREST_SECRET_KEY - Enviroment Key for Forest Admin
    • FOREST_AUTH_KEY - Auth Key for Forest Admin

• Database

  • This app uses postgres. Homebrew is the suggested installation method on a Mac.

• Environment

  • This app uses .env to load up environment variables in development. Run cp .env.test .env
  • bundle install
  • bundle exec rake db:setup

• Testing

  • This app uses Minitest and the m gem.
    • bundle exec rake db:test:prepare
    • bundle exec m
  • Ensure code passes Rubocop. Run bundle exec rubocop

• Deploy

  • We deploy to Heroku.
  • After passing CI, the Develop branch is deployed automatically to Staging
  • After passing CI, the Master branch is deployed automatically to Production
  • New Pull Requests get Review apps automatically created for them