Skip to content

Commit

Permalink
improve readme with install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
JeSuisUnCaillou committed Jun 4, 2024
1 parent 351d382 commit 04e6aa7
Showing 1 changed file with 28 additions and 12 deletions.
40 changes: 28 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,40 @@
# README

This README would normally document whatever steps are necessary to get the
application up and running.
## Install project

Things you may want to cover:
### Database credentials
Ask a dev for the 3 keys necessary to decrypt the secrets :
- `config/master.key`
- `config/credentials/development.key`
- `config/credentials/test.key`

* Ruby version

* System dependencies
Get the credentials for the db like this (we'll call them `theuser` and `thepassword`)

* Configuration
```sh
rails credentials:show
```

* Database creation
and then

* Database initialization
```sh
sudo su - postgres

* How to run the test suite
psql
```

* Services (job queues, cache servers, search engines, etc.)
```SQL
> CREATE ROLE theuser WITH SUPERUSER CREATEDB LOGIN PASSWORD 'thepassword';
```

* Deployment instructions
then `rails db:setup`

* ...
### Run project

```sh
bundle install
raisl assets:precompile
rails s
```

Then you can visit `localhost:3000`

0 comments on commit 04e6aa7

Please sign in to comment.