File	Date	Author	Commit
app	2019-02-09	Oliver Valls	[db7412] [REFACTOR] Milestone stories ordering should be...
config	2019-05-24	Oliver Valls	[6ee253] [CONFIG] Define files to precompile.
db	2018-04-27	Oliver Valls	[5101cd] [FEATURE] Introduce new Story.estimate field.
doc	2017-02-07	oliver	[8b1e4d] [REFACTOR|DOC]
lib	2017-07-17	oliver	[75a0a4] [FIX] weekly_works report query.
public	2014-05-15	oliver	[ad1c55] Bootstrapping 1: upgraded to rails 3.1, asset c...
script	2013-05-13	Oliver	[fef281] Update git to last commit to svn (first imporat...
test	2018-04-27	Oliver Valls	[5101cd] [FEATURE] Introduce new Story.estimate field.
.gitignore	2015-09-26	oliver	[f185fb] [CONFIG] Ignore .ruby-version file.
GPL_license.txt	2009-06-18	tramuntanal	[8eff4f] New licensing model: GPL or PPL.
Gemfile	2019-05-22	Oliver Valls	[ff12d5] Include puma gem in gemfile.
Gemfile.lock	2019-05-22	Oliver Valls	[ff12d5] Include puma gem in gemfile.
LICENSING	2009-07-10	tramuntanal	[ffc5ab] Licensing lists dependencies.
PPL_license.txt	2009-06-18	tramuntanal	[8eff4f] New licensing model: GPL or PPL.
README	2014-05-06	oliver	[26c1de] [DOC]
Rakefile	2013-05-13	Oliver	[fef281] Update git to last commit to svn (first imporat...
config.ru	2013-05-13	Oliver	[ea0837] [ADMIN] Pending files to be imported to git.

Read Me

******************
* WINDS OF SCRUM *
******************


This is a Winds of Scrum release tested for Rails 3.0.6.

INSTALLATION AND CONFIGURATION
==============================

During this installation reference the environment variable $WINDSOFSCRUM_HOME refers to the directory where Winds of Scrum is. For example: /home/oliver/prog/ruby/projects/windsofscrum

Installing Dependencies
-----------------------
The following list of gems is required:
* authlogic
	sudo gem install authlogic

* mysql (if using mysql DBMS)
  # On Ubuntu:
	sudo apt-get install libmysqlclient-dev ;(possibly)
	sudo gem install mysql
  # On MacOS X:
	gem install mysql -- --include=/usr/local/lib
  # On Windows:
	gem install mysql
	  Choose the win32 build.
	  Install MySQL and put its /bin directory on your path.

* postgres (if using postgresql DBMS)
	sudo gem install pg

Remember that drivers like postgres and mysql require to have ruby development libraries installed:
sudo apt-get install ruby1.8-dev
sudo apt-get install libpq-dev

Configuring Database
--------------------
Assuming the correct gems have been installed to connect to your DBMS, $WINDSOFSCRUM_HOME/config/database.yml will probably need to be configured according to your database configuration.
To do so, use the database.yml.template. For example:
    WINDSOFSCRUM_HOME> cp config/database.yml.template config/database.yml

On the database configuration there's a section for each execution environment that must be configured.
* adapter: is the driver to use for connecting to the database, for example the mysql or postgresql.
* encodig: Forces the encoding of the connection to be made in UTF-8.
* database: the database name on the DBMS.
* username: the username to use for connecting to the db.
* password: the passwor of 'username'.
* host: don't connect through socket (for those using jruby).

For production only the production section must be parameterized.
By default this project is configured to run on a mysql DBMS.
It uses a 'windsofscrum' schema for development and production as this environments doesn't use to be executed on the same machine.

- Useful configuration sentences for PostgreSQL:
CREATE DATABASE windsofscrum WITH ENCODING='UTF8';
CREATE USER pig WITH PASSWORD '4F0s8wj';
-- ALTER Role pig CREATEDB; <-- this is removing the LOGIN role to pig so don't do it
GRANT ALL PRIVILEGES ON DATABASE windsofscrum TO pig;

- Configuration for MySql:
CREATE DATABASE windsofscrum CHARACTER SET utf8 COLLATE utf8_general_ci;
CREATE USER 'pig' IDENTIFIED BY '4F0s8wj';
CREATE USER 'pig'@'localhost' IDENTIFIED BY '4F0s8wj';
GRANT ALL PRIVILEGES ON windsofscrum.* TO pig@localhost;

- Creating tables
	Simply from your $WINDSOFSCRUM_HOME execute the command:

$ rake db:schema:load
$ rake db:seed


USERS
=====
    By default an administrator user is added to the DB.
login:  admin
pwd:    songoku

    Remember to update administrator's password just after deploying the app.
    It is not that this "administrator" user will have more permissions or privileges over new users but it's called like this as a convention.