Add a description for your project here
- Ruby - You will need at least version: 2.7.0, we use RVM to manage different versions of Ruby.
- Postgres - We use Postgres for our database, install it locally on Mac OSX with Homebrew. Once installed you can run
brew services start postgresql. - Redis - Install a redis server locally with
brew install redisand then runbrew services start redisto get it up and running.
- Git clone the repo to your local machine
- Change into the directory with
cd tfl_graph bundle installto install ruby dependencies.yarn installto install frontend depenencies.db:create && db:migrate && db:seedbuilds the database, runs initial migrations and seeds the database- To run the app use a process manager like hivemind to run the app locally from the development Procfile
hivemind Procfile.dev. This mirrors how the app will run in production on Heroku.
This project uses brakeman to detect potential security vulnerabilities. Run brakeman in the root of the project to do a security scan.
We use rspec for automated tests. Run the test suite with bundle exec rspec from the project root.
Don't document the program; program the document. -- unknown
Documentation is important for your hygiene.
Write and find the documentation in the docs directory.
This project uses Architectural Decision Records to document technical decisions.
Read the architectural decisions
The project uses rubocop to maintain code style and format consistency. It uses the following rubocop extensions: