From f9ffefb47d13d54d9545d7f3cf8a5e862180c212 Mon Sep 17 00:00:00 2001 From: JuanmaLambre Date: Sat, 17 Dec 2016 13:35:16 -0300 Subject: [PATCH 1/5] Add info to README --- README.md | 48 +++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 39 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 7db80e4..dad85f2 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,50 @@ 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´´´. Check that installation was successful by running ´´´rails --version´´´ -* Deployment instructions -* ... +## 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) From e4de1e52e1e01a44276892b5f6e734c7fe3ad1f9 Mon Sep 17 00:00:00 2001 From: JuanmaLambre Date: Sat, 17 Dec 2016 13:39:03 -0300 Subject: [PATCH 2/5] Correct README.md --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index dad85f2..6866fe1 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ Things you may want to cover: * Ruby 2.3 * SQLite3 -To install Rails you can simply execute ´´´gem install rails´´´. Check that installation was successful by running ´´´rails --version´´´ +To install Rails you can simply execute ```gem install rails```. Check that installation was successful by running ```rails --version``` ## Rails "Getting Started" @@ -28,27 +28,27 @@ To install Rails you can simply execute ´´´gem install rails´´´. Check tha ## Database creation Install project dependencies: -´´´bundle install´´´ +```bundle install``` And then create the database: -´´´rake db:create´´´ +```rake db:create``` Finally, migrate the database -´´´rake db:migrate´´´ +```rake db:migrate``` To populate the database run -´´´rake db:seed´´´ +```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 +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´´´ +```rake test``` For more information consult the [official testing guide](http://guides.rubyonrails.org/testing.html) From c94a23c7784038a0eecb48a7b321a1e8c60db70b Mon Sep 17 00:00:00 2001 From: JuanmaLambre Date: Sat, 17 Dec 2016 13:41:16 -0300 Subject: [PATCH 3/5] Insert new lines --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 6866fe1..2222fab 100644 --- a/README.md +++ b/README.md @@ -22,22 +22,23 @@ To install Rails you can simply execute ```gem install rails```. Check that inst ## 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. +[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: +Install project dependencies: ```bundle install``` -And then create the database: +And then create the database: ```rake db:create``` -Finally, migrate the database +Finally, migrate the database ```rake db:migrate``` -To populate the database run -```rake db:seed``` +To populate the database run +```rake db:seed``` Note that this will execute db/seeds.rb @@ -48,7 +49,7 @@ To insert a breakpoint you must invoke ```byebug``` at desired line. This will o ## Testing -To run the tests execute -```rake test``` +To run the tests execute +```rake test``` For more information consult the [official testing guide](http://guides.rubyonrails.org/testing.html) From 4291bfc54cf1dc35171b6538d01182240165656b Mon Sep 17 00:00:00 2001 From: JuanmaLambre Date: Sat, 17 Dec 2016 13:42:27 -0300 Subject: [PATCH 4/5] Insert new lines --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 2222fab..cfbe79d 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,10 @@ Things you may want to cover: * Ruby 2.3 * SQLite3 -To install Rails you can simply execute ```gem install rails```. Check that installation was successful by running ```rails --version``` +To install Rails you can simply execute +```gem install rails``` +Check that installation was successful by running +```rails --version``` ## Rails "Getting Started" From 72f07904981fc918383e7b962533bb7cf57565cf Mon Sep 17 00:00:00 2001 From: JuanmaLambre Date: Sat, 17 Dec 2016 13:44:09 -0300 Subject: [PATCH 5/5] Edit README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cfbe79d..9bba249 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ Things you may want to cover: To install Rails you can simply execute ```gem install rails``` + Check that installation was successful by running ```rails --version``` @@ -42,7 +43,7 @@ Finally, migrate the database To populate the database run ```rake db:seed``` -Note that this will execute db/seeds.rb +_(Note that this will execute db/seeds.rb)_ ## Debugging