-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
improve readme with install instructions
- Loading branch information
1 parent
351d382
commit 04e6aa7
Showing
1 changed file
with
28 additions
and
12 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` |