00_INSTALLATION.md

MENU README | How to run locally | REST API doc | Web app screenshots

✨ Solid Rails App

Instructions to setup and run the application locally.

📚 Table of contents

• System dependencies
• How to setup the application
• How to run the application locally
• How to run the test suite (and generate coverage report)
• How to generate the code quality
• How to generate the App statistics

System dependencies

• SQLite3
• Ruby 3.3.1
  • bundler >= 2.5.6

How to setup the application

1. Install system dependencies
2. Access one of the branches
3. Create a config/master.key file with the following content:

echo 'a061933f96843c82342fb8ab9e9db503' > config/master.key

chmod 600 config/master.key

3. Run bin/setup

⬆ back to top

How to run the application locally

1. bin/rails s
2. Open in your browser: http://localhost:3000

⬆ back to top

How to run the test suite (and generate coverage report)

• bin/rails test

How to generate the code quality

• bin/rails rubycritic

How to generate the App statistics

• bin/rails stats

⬆ back to top