diff options
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 70 | 
1 files changed, 70 insertions, 0 deletions
| diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 000000000..16514d5c4 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,70 @@ +# Installation Guide + +This guide is based on mac/OS with [Homebrew](https://brew.sh/) and [RVM](https://rvm.io/) + +## Ruby + +Get a correct `.ruby-version` (Can we remove it from `.gitignore`?) +and install that version. + +Example with [rvm](https://rvm.io/): + +        rvm install 2.3.0 + +Add the bundler gem + +        gem install bundler + +Go into your local repro and install the gems + +        bundle + +### Caveats + +`libv8` might cause you troubles, depending on your local configuration. If you have `libv8` installed (probably because of `node.js`) you might need to tell bundler/Rubygems to use the system version. + + +        bundle config build.libv8 --with-system-v8 +        bundle + +or  +        gem install libv8 -v '<version>' -- --with-system-v8 +        bundle + +You will get the correct value of `<version>` from bundler's error message. + +## Rails + +### Dependencies + +As documented [here](https://github.com/dryade/georuby-ext/issues/2) we need some more libs before we can start the `rake` setup tasks. On mac/OS the easiest way is just to install `postgis` now with `homebrew` as this will +install all needed libraries. + +### Postgres + +#### Create user + +      createuser -s -U $USER -P chouette +                  ^    ^      ^ +                  |    |      +---- prompt for passwd +                  |    +----- as your default postgres user (remove in case of different config) +                  +---------- superuser + +When promted for the password enter the highly secure string `chouette`. + + +#### Create database + +      bundle exec rake db:migrate +      RAILS_ENV=test bundle exec rake db:migrate + +#### Install node.js packages + +      bundle exec rake npm:install + +### SSO Configuration + +Get yourself an invitation to [Stif Portail](http://stif-portail-dev.af83.priv/) and be sure to update your information +on your [profile page](http://stif-portail-dev.af83.priv/users/edit)   +   +  | 
