Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme completion #3

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 44 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,55 @@ application up and running.

Things you may want to cover:

* Ruby version
* Services (job queues, cache servers, search engines, etc.)

* System dependencies
* Deployment instructions

* Configuration
* ...

* Database creation

* Database initialization
## System dependencies

* How to run the test suite
* Ruby 2.3
* SQLite3

* Services (job queues, cache servers, search engines, etc.)
To install Rails you can simply execute
```gem install rails```

* Deployment instructions
Check that installation was successful by running
```rails --version```

* ...

## Rails "Getting Started"

[Here](http://guides.rubyonrails.org/getting_started.html) you can find the official starting tutorial for Ruby on Rails.
You can also take a look at Michael Hartl's ["Ruby on Rails Tutorial"](https://www.railstutorial.org/book). The book offers a detailed tutorial for building a whole application from scratch. It is available online for free.


## Database creation

Install project dependencies:
```bundle install```

And then create the database:
```rake db:create```

Finally, migrate the database
```rake db:migrate```

To populate the database run
```rake db:seed```
_(Note that this will execute db/seeds.rb)_


## Debugging

To insert a breakpoint you must invoke ```byebug``` at desired line. This will open a debugging console where the server is running


## Testing

To run the tests execute
```rake test```

For more information consult the [official testing guide](http://guides.rubyonrails.org/testing.html)