Description to be added
- Make sure you have Ruby on Rails installed
- On Windows I recommend RailsInstaller
- On Mac and Linux I recommend installation through ASDF
- Make sure you have Postgres installed. I suggest to get the version from the
.tool-versions
file.- You could use this guide for Windows 10. Once you open pgAdmin you can set the master password.
- It's a bit different on Mac & Linux. I suggest using your favourite package manager (apt, brew, asdf).
- Create
config/database.yml
. Useconfig/database.yml.example
- Run
bundle install
in the project directory - Create and migrate the database
bundle exec rails db:create
andbundle exec rails db:migrate
in the project directory - Install JS dependencies with
yarn install
in the project directory - Run webpacker with
bundle exec rails webpacker:install
in the project directory - Once the configuration above is complete you can start the application server with
bundle exec rails server
This README would normally document whatever steps are necessary to get the application up and running.
Things you may want to cover:
-
Ruby version
-
System dependencies
-
Configuration
-
Database creation
-
Database initialization
-
How to run the test suite
-
Services (job queues, cache servers, search engines, etc.)
-
Deployment instructions
-
...