Commit b6dee2ddd4106bbd852f6117cea31cc23df72b38
1 parent
d4f5c2b5
Exists in
colab
and in
2 other branches
Update README
Showing
1 changed file
with
5 additions
and
93 deletions
Show diff stats
README.md
| ... | ... | @@ -6,99 +6,6 @@ Prezento is the web interface for Mezuro. |
| 6 | 6 | |
| 7 | 7 | Mezuro project aims provide a platform to compare projects and metric techniques, teach how to use metrics through configurations, analyze code, avoid technical debts, and disseminate code metrics usage and understanding. |
| 8 | 8 | |
| 9 | -### Contributing | |
| 10 | - | |
| 11 | -Please, have a look the wiki pages about development workflow and code standards: | |
| 12 | - | |
| 13 | -* https://github.com/mezuro/mezuro/wiki/Development-workflow | |
| 14 | -* https://github.com/mezuro/mezuro/wiki/Standards | |
| 15 | - | |
| 16 | -### Development | |
| 17 | - | |
| 18 | - | |
| 19 | -* System dependencies (Ubuntu 14.04 package names) | |
| 20 | - * build-essential | |
| 21 | - * curl | |
| 22 | - * postgresql-server-dev-9.3 | |
| 23 | - | |
| 24 | -* Unpacked dependecies | |
| 25 | - * PhantomJS >= 1.9.2 (http://phantomjs.org/) | |
| 26 | - * *NOTE:* Just create sym links for that, for example: | |
| 27 | - | |
| 28 | - ```bash | |
| 29 | - cd /usr/local/share | |
| 30 | - wget https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-1.9.7-linux-x86_64.tar.bz2 | |
| 31 | - tar xjf phantomjs-1.9.7-linux-x86_64.tar.bz2 | |
| 32 | - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/local/share/phantomjs | |
| 33 | - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/local/bin/phantomjs | |
| 34 | - sudo ln -s /usr/local/share/phantomjs-1.9.7-linux-x86_64/bin/phantomjs /usr/bin/phantomjs | |
| 35 | - ``` | |
| 36 | - | |
| 37 | -* Ruby version | |
| 38 | - | |
| 39 | - `2.3.0` | |
| 40 | - | |
| 41 | - You can easily install it through the Ruby Version Manager - RVM. Instructions on how to do it can be found at http://rvm.io | |
| 42 | - | |
| 43 | - *NOTE:* If you are using the gnome-shell, or any derivate like terminator, you have to mark on your profile the option to use a "login bash". | |
| 44 | - | |
| 45 | - | |
| 46 | -* Configuration | |
| 47 | - | |
| 48 | - `bundle install` | |
| 49 | - | |
| 50 | -* Database creation | |
| 51 | - | |
| 52 | - `rake db:create` | |
| 53 | - | |
| 54 | -* Database initialization (The seeds script will need the kalibro configurations service running) | |
| 55 | - | |
| 56 | - `rake db:setup` | |
| 57 | - | |
| 58 | -* Alternatively you can just run the setup script (Will also need the kalibro configurations service running) | |
| 59 | - | |
| 60 | - `bin/setup` | |
| 61 | - | |
| 62 | -* How to run the test suite | |
| 63 | - | |
| 64 | - `rake` | |
| 65 | - | |
| 66 | -* Services (job queues, cache servers, search engines, etc.) | |
| 67 | - | |
| 68 | - *Kalibro Processor* - version 1.1.6 (https://github.com/mezuro/kalibro_processor/archive/v1.1.6.tar.gz) | |
| 69 | - You can find it at https://github.com/mezuro/kalibro_processor | |
| 70 | - By default Mezuro will expect it to be running on port 8082 at localhost. | |
| 71 | - In order to run it as expected, run on two different terminal instances: | |
| 72 | - | |
| 73 | - ```bash | |
| 74 | - RAILS_ENV=local rails s -p 8082 | |
| 75 | - RAILS_ENV=local rake jobs:work | |
| 76 | - ``` | |
| 77 | - | |
| 78 | - *Kalibro Configurations* - version 1.2.5 (https://github.com/mezuro/kalibro_configurations/archive/v1.2.5.tar.gz) | |
| 79 | - You can find it at https://github.com/mezuro/kalibro_configurations | |
| 80 | - By default Mezuro will expect it to be running on port 8083 at localhost. | |
| 81 | - In order to run it as expected, run on two different terminal instances: <tt>rails s -p 8083</tt>. | |
| 82 | - | |
| 83 | -* Deployment instructions | |
| 84 | - | |
| 85 | - Deployment is made through Capistrano (https://github.com/capistrano/capistrano) | |
| 86 | - | |
| 87 | - `cap production deploy` | |
| 88 | - | |
| 89 | - In order to do this, you must have the password. | |
| 90 | - | |
| 91 | - Otherwise, you can also modify the deployment file at <tt>config/deploy.rb</tt>. | |
| 92 | - | |
| 93 | -### Install | |
| 94 | - | |
| 95 | -* First Deploy | |
| 96 | - | |
| 97 | - 1. Make sure that the deployment file <tt>config/deploy.rb</tt> is correctly configured to the installation server; | |
| 98 | - 2. Also, make sure that the installation server already has rvm installed; | |
| 99 | - 3. <tt>cap deploy:setup</tt> will install the ruby correct ruby version, the gemset and all the directories tree; | |
| 100 | - 4. <tt>cap deploy:migrations</tt> deploys the code and run all the migrations | |
| 101 | - | |
| 102 | 9 | ### License |
| 103 | 10 | |
| 104 | 11 | Copyright (c) 2013-2016 The Author developers. |
| ... | ... | @@ -130,3 +37,8 @@ http://ccsl.ime.usp.br |
| 130 | 37 | |
| 131 | 38 | Brazilian National Research Council (CNPQ) |
| 132 | 39 | http://www.cnpq.br/ |
| 40 | + | |
| 41 | +University of Brasilia (UnB) | |
| 42 | +Faculdade UnB Gama | |
| 43 | +https://fga.unb.br/ | |
| 44 | +https://softwarepublico.gov.br/social/ | ... | ... |