|
1 |
| -# README |
| 1 | +# Ruby on Rails Tutorial sample application |
2 | 2 |
|
3 |
| -This README would normally document whatever steps are necessary to get the |
4 |
| -application up and running. |
| 3 | +This is the sample application for the |
| 4 | +[*Ruby on Rails Tutorial: |
| 5 | +Learn Web Development with Rails*](https://www.railstutorial.org/) |
| 6 | +by [Michael Hartl](https://www.michaelhartl.com/). |
5 | 7 |
|
6 |
| -Things you may want to cover: |
| 8 | +## License |
7 | 9 |
|
8 |
| -* Ruby version |
| 10 | +All source code in the [Ruby on Rails Tutorial](https://www.railstutorial.org/) |
| 11 | +is available jointly under the MIT License and the Beerware License. See |
| 12 | +[LICENSE.md](LICENSE.md) for details. |
9 | 13 |
|
10 |
| -* System dependencies |
| 14 | +## Getting started |
11 | 15 |
|
12 |
| -* Configuration |
| 16 | +To get started with the app, clone the repo and then install the needed gems: |
13 | 17 |
|
14 |
| -* Database creation |
| 18 | +``` |
| 19 | +$ gem install bundler -v 2.2.33 |
| 20 | +$ bundle _2.2.33_ config set --local without 'production' |
| 21 | +$ bundle _2.2.33_ install |
| 22 | +``` |
15 | 23 |
|
16 |
| -* Database initialization |
| 24 | +Next, migrate the database: |
17 | 25 |
|
18 |
| -* How to run the test suite |
| 26 | +``` |
| 27 | +$ rails db:migrate |
| 28 | +``` |
19 | 29 |
|
20 |
| -* Services (job queues, cache servers, search engines, etc.) |
| 30 | +Finally, run the test suite to verify that everything is working correctly: |
21 | 31 |
|
22 |
| -* Deployment instructions |
| 32 | +``` |
| 33 | +$ rails test |
| 34 | +``` |
23 | 35 |
|
24 |
| -* ... |
| 36 | +If the test suite passes, you'll be ready to run the app in a local server: |
| 37 | + |
| 38 | +``` |
| 39 | +$ rails server |
| 40 | +``` |
| 41 | + |
| 42 | +For more information, see the |
| 43 | +[*Ruby on Rails Tutorial* book](https://www.railstutorial.org/book). |
0 commit comments