Add installation and diagram generation instructions
This commit is contained in:
parent
6908472def
commit
fca3cefb59
35
README.md
35
README.md
|
|
@ -1,24 +1,15 @@
|
||||||
# README
|
# turniere-backend
|
||||||
|
Ruby on Rails application serving as backend for turnie.re
|
||||||
|
|
||||||
This README would normally document whatever steps are necessary to get the
|
# Installation
|
||||||
application up and running.
|
```
|
||||||
|
# install dependencies
|
||||||
|
$ bundle install
|
||||||
|
# run migrations
|
||||||
|
$ rails db:migrate
|
||||||
|
```
|
||||||
|
|
||||||
Things you may want to cover:
|
# Generate diagrams
|
||||||
|
```
|
||||||
* Ruby version
|
rails diagram:all_with_engines
|
||||||
|
```
|
||||||
* System dependencies
|
|
||||||
|
|
||||||
* Configuration
|
|
||||||
|
|
||||||
* Database creation
|
|
||||||
|
|
||||||
* Database initialization
|
|
||||||
|
|
||||||
* How to run the test suite
|
|
||||||
|
|
||||||
* Services (job queues, cache servers, search engines, etc.)
|
|
||||||
|
|
||||||
* Deployment instructions
|
|
||||||
|
|
||||||
* ...
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue