goodscary / firstrubyfriend

Rails app to administer the friendliest programmer mentoring programme in the world
5 stars 3 forks source link

README

Setup

If you'd like to contribute to this project, follow the steps below to set it up:

  1. Fork the repository
  2. Clone the forked repo onto your machine, then cd into the project directory
  3. Run bin /setup to install dependencies and prepare the database
  4. Start the server with rails s or bin/dev

Tests

You can run tests with rails test. To run all tests in a file, use rails test filename.rb. To run a single test, pass in a line number rails test filename.rb:10.

Debugging

We use the debug gem for debugging. Breakpoints don't work with bin/dev, so make sure to start the server with rails s if you want to use binding.break, debugger or binding.b.

About this project

CSS

This app uses styles provided by tailwind CSS. Whenever possible, try to avoid adding any custom styles.

Authentication

This project uses the pre-built authentication system generated by Authentication Zero. When implementing new auth-related functionality, check if the gem can provide this first.