Skip to content
This repository has been archived by the owner on May 21, 2024. It is now read-only.

nathanbirrell/poseidon

Repository files navigation

Poseidon

The Ruby on Rails application behind Poseidon.

Getting Started

  1. Install RVM
  2. Install RubyGems
  3. Install Postgres brew install postgresql
  4. Install the correct version of Ruby on your machine - rvm install ruby-2.3.3 && rvm use ruby-2.3.3
  5. Install Bundler and Rails
  6. Install Heroku CLI brew install heroku/brew/heroku
  7. Clone this repo - git clone git@github.com:nathanbirrell/poseidon.git poseidon
  8. Install project dependencies - cd poseidon; bundle install. [Note if you have an issue with the pg gem, make sure you run brew install postgresql and bundle again.]
  9. Find a template config/application.yml file for your environment variables (handled by Figaro)
  10. Create, set-up and seed database with rails db:create db:schema:load db:seed
  11. Load some model data for the seed spots with rails forecasts:update (retrieves data from 3rd party APIs)
  12. npm install -g yarn then yarn
  13. Run a local build with npm start
  14. Install Rubocop and the Ruby Style Guide (Atom, RubyMine)

Marketing site (Jekyll)

The marketing site (surfposeidon.io) is a static rendering of app/javascript/pages/MarketingPage.js - basically copied and pasted out of the browser.

From there, we copy the HTML to docs/index.html for Github Pages to serve up.

Documentation and Support

Github Wiki Slack

Features & Issues

Trello Team (for build/feature work)

Github Issues (for bugs)