Developer Handbook

Last updated 8 months ago

Getting started

Read the Glossary.

Tools

We use:

Hosting / Environment

  • Rails 5 / Ruby 2.4 / postgresql

  • rails db:setup db:migrate seed:migrate

  • rails import:all_events

  • To log in you need to go to /users and then /superadmin (for now!)

  • master branch auto-deploys to our staging server http://placecal-staging.org. production branch deploys manually to the production server.

Notes

We’re using the Mountain View gem for frontend components. Anything and everything reusable should be encapsulated in a component and given some mocks to test it. Components are at https://placecal.org/styleguide. For each component add a line to test/controllers/components_test.rb: easy tests!

Important information should be added in a seed migration.

Ideally the Sketch art should export directly into our repo file structure somehow, so if we can work towards having a master Sketch file for anything live then take the time to do it.

User access

See the User Access Guide

Roadmap

See the current Roadmap

Getting API access

This is still in development. Drop us an email to have a chat about it.