Add installation and diagram generation instructions

This commit is contained in:
Thor77 2018-11-12 14:05:56 +01:00
parent 6908472def
commit fca3cefb59
1 changed files with 13 additions and 22 deletions

View File

@ -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
application up and running.
# Installation
```
# install dependencies
$ bundle install
# run migrations
$ rails db:migrate
```
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
* ...
# Generate diagrams
```
rails diagram:all_with_engines
```