Commit 8f0af5b6ad7435e3263013a9fb3ddd2baeae2aae
Exists in
colab
and in
4 other branches
Merge pull request #308 from mezuro/update_docs
Update docs
Showing
3 changed files
with
39 additions
and
21 deletions
Show diff stats
README.rdoc
| @@ -28,7 +28,7 @@ Please, have a look the wiki pages about development workflow and code standards | @@ -28,7 +28,7 @@ Please, have a look the wiki pages about development workflow and code standards | ||
| 28 | 28 | ||
| 29 | * PhantomJS >= 1.9.2 (http://phantomjs.org/) | 29 | * PhantomJS >= 1.9.2 (http://phantomjs.org/) |
| 30 | 30 | ||
| 31 | - *NOTE:* Just create sym links for that | 31 | + *NOTE:* Just create sym links for that, for example: |
| 32 | 32 | ||
| 33 | cd /usr/local/share | 33 | cd /usr/local/share |
| 34 | wget https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.7-linux-x86_64.tar.bz2 | 34 | wget https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.7-linux-x86_64.tar.bz2 |
| @@ -54,17 +54,21 @@ Please, have a look the wiki pages about development workflow and code standards | @@ -54,17 +54,21 @@ Please, have a look the wiki pages about development workflow and code standards | ||
| 54 | 54 | ||
| 55 | rake db:create | 55 | rake db:create |
| 56 | 56 | ||
| 57 | -* Database initialization | 57 | +* Database initialization (The seeds script will need the kalibro configurations service running) |
| 58 | 58 | ||
| 59 | rake db:setup | 59 | rake db:setup |
| 60 | 60 | ||
| 61 | +* Alternatively you can just run the setup script (Will also need the kalibro configurations service running) | ||
| 62 | + | ||
| 63 | + bin/setup | ||
| 64 | + | ||
| 61 | * How to run the test suite | 65 | * How to run the test suite |
| 62 | 66 | ||
| 63 | rake | 67 | rake |
| 64 | 68 | ||
| 65 | * Services (job queues, cache servers, search engines, etc.) | 69 | * Services (job queues, cache servers, search engines, etc.) |
| 66 | 70 | ||
| 67 | - *Kalibro Processor* - version 0.9.2 (https://github.com/mezuro/kalibro_processor/archive/v0.9.2.tar.gz) | 71 | + *Kalibro Processor* - version 1.1.6 (https://github.com/mezuro/kalibro_processor/archive/v1.1.6.tar.gz) |
| 68 | You can find it at https://github.com/mezuro/kalibro_processor | 72 | You can find it at https://github.com/mezuro/kalibro_processor |
| 69 | By default Mezuro will expect it to be running on port 8082 at localhost. | 73 | By default Mezuro will expect it to be running on port 8082 at localhost. |
| 70 | In order to run it as expected, run on two different terminal instances: | 74 | In order to run it as expected, run on two different terminal instances: |
| @@ -72,7 +76,7 @@ Please, have a look the wiki pages about development workflow and code standards | @@ -72,7 +76,7 @@ Please, have a look the wiki pages about development workflow and code standards | ||
| 72 | RAILS_ENV=local rails s -p 8082 | 76 | RAILS_ENV=local rails s -p 8082 |
| 73 | RAILS_ENV=local rake jobs:work | 77 | RAILS_ENV=local rake jobs:work |
| 74 | 78 | ||
| 75 | - *Kalibro Configurations* - version 1.0.0 (https://github.com/mezuro/kalibro_configurations/archive/v1.0.0.tar.gz) | 79 | + *Kalibro Configurations* - version 1.2.5 (https://github.com/mezuro/kalibro_configurations/archive/v1.2.5.tar.gz) |
| 76 | You can find it at https://github.com/mezuro/kalibro_configurations | 80 | You can find it at https://github.com/mezuro/kalibro_configurations |
| 77 | By default Mezuro will expect it to be running on port 8083 at localhost. | 81 | By default Mezuro will expect it to be running on port 8083 at localhost. |
| 78 | In order to run it as expected, run on two different terminal instances: <tt>rails s -p 8083</tt>. | 82 | In order to run it as expected, run on two different terminal instances: <tt>rails s -p 8083</tt>. |
| @@ -98,7 +102,7 @@ Please, have a look the wiki pages about development workflow and code standards | @@ -98,7 +102,7 @@ Please, have a look the wiki pages about development workflow and code standards | ||
| 98 | 102 | ||
| 99 | === License | 103 | === License |
| 100 | 104 | ||
| 101 | -Copyright (c) 2013-2015 The Author developers. | 105 | +Copyright (c) 2013-2016 The Author developers. |
| 102 | 106 | ||
| 103 | This program is free software: you can redistribute it and/or modify | 107 | This program is free software: you can redistribute it and/or modify |
| 104 | it under the terms of the GNU Affero General Public License as published by | 108 | it under the terms of the GNU Affero General Public License as published by |
| 1 | #!/usr/bin/env ruby | 1 | #!/usr/bin/env ruby |
| 2 | require 'pathname' | 2 | require 'pathname' |
| 3 | +require 'colorize' | ||
| 4 | + | ||
| 5 | +def run(command) | ||
| 6 | + system(command) | ||
| 7 | + unless $?.exitstatus.zero? | ||
| 8 | + puts "Command #{command} exited with nonzero status".red | ||
| 9 | + exit 1 | ||
| 10 | + end | ||
| 11 | +end | ||
| 3 | 12 | ||
| 4 | # path to your application root. | 13 | # path to your application root. |
| 5 | APP_ROOT = Pathname.new File.expand_path('../../', __FILE__) | 14 | APP_ROOT = Pathname.new File.expand_path('../../', __FILE__) |
| @@ -8,22 +17,27 @@ Dir.chdir APP_ROOT do | @@ -8,22 +17,27 @@ Dir.chdir APP_ROOT do | ||
| 8 | # This script is a starting point to setup your application. | 17 | # This script is a starting point to setup your application. |
| 9 | # Add necessary setup steps to this file: | 18 | # Add necessary setup steps to this file: |
| 10 | 19 | ||
| 11 | - puts "== Installing dependencies ==" | ||
| 12 | - system "gem install bundler --conservative" | ||
| 13 | - system "bundle check || bundle install" | 20 | + puts "== Installing dependencies ==".green |
| 21 | + run "gem install bundler --conservative" | ||
| 22 | + run "bundle check || bundle install" | ||
| 14 | 23 | ||
| 15 | - # puts "\n== Copying sample files ==" | ||
| 16 | - # unless File.exist?("config/database.yml") | ||
| 17 | - # system "cp config/database.yml.sample config/database.yml" | ||
| 18 | - # end | 24 | + puts "\n== Copying sample files ==".green |
| 25 | + unless File.exist?("config/database.yml") | ||
| 26 | + run "cp config/database.yml.sample config/database.yml" | ||
| 27 | + end | ||
| 19 | 28 | ||
| 20 | - puts "\n== Preparing database ==" | ||
| 21 | - system "bin/rake db:setup" | 29 | + puts "\n== Preparing database ==".green |
| 30 | + puts "\n== Create database ==".yellow | ||
| 31 | + run "bin/rake db:create" | ||
| 32 | + puts "\n== Run migrations ==".yellow | ||
| 33 | + run "bin/rake db:migrate" | ||
| 34 | + puts "\n== Run seeds (may fail if the Kalibro Configurations Service is not up and running) ==".yellow | ||
| 35 | + run "bin/rake db:seed" | ||
| 22 | 36 | ||
| 23 | - puts "\n== Removing old logs and tempfiles ==" | ||
| 24 | - system "rm -f log/*" | ||
| 25 | - system "rm -rf tmp/cache" | 37 | + puts "\n== Removing old logs and tempfiles ==".green |
| 38 | + run 'bin/rake log:clear' | ||
| 39 | + run 'bin/rake tmp:clear' | ||
| 26 | 40 | ||
| 27 | - puts "\n== Restarting application server ==" | ||
| 28 | - system "touch tmp/restart.txt" | ||
| 29 | -end | ||
| 30 | \ No newline at end of file | 41 | \ No newline at end of file |
| 42 | + puts "\n== Restarting application server ==".green | ||
| 43 | + run "touch tmp/restart.txt" | ||
| 44 | +end |
public/humans.txt