Skip to content

Latest commit

 

History

History
101 lines (67 loc) · 2.31 KB

Readme.md

File metadata and controls

101 lines (67 loc) · 2.31 KB
Raw

SP-Gestion

Code status

Tests : Build Status

Coverage : Coverage Status

Quality : Code Climate

Dependencies : Dependency Status

Prerequisites

  • Ruby 2.2.5 or greater
  • Mysql
  • memcached
  • ImageMagick
  • HTTP server with ruby support (Passenger, Puma...)

Setup

  • checkout source :
git clone https://github.com/osaris/sp-gestion.git
  • go into master :
cd sp-gestion
  • install bundler :
gem install bundler
  • install all required gem :
bundle install

  • copy config/sp-gestion.sample.yml to config/sp-gestion.yml and change its content to fit your setup

  • edit config/database.yml (if necessary)

  • create database, load schema and import seed data :

rake db:setup
  • setup local dns for *.dev resolution or configure www.sp-gestion.dev and cpi-demo.sp-gestion.dev via hostfile
  • browse www.sp-gestion.dev for home
  • browse cpi-demo.sp-gestion.dev for a sample account (login : [email protected] | pass : demospg)

You can switch cpi-demo (or any other account) to demo mode by setting to true the demo flag on the Station model. Then you can generate demo data with rake spg:reset_demo_stations.

Emails

Development environment is configured to use Mailcatcher. Simply run gem install mailcatcher then mailcatcher to get started.

Tests

  • prepare database :
rake db:test:prepare
  • run rspec

Deployment

  • Capistrano is included in the Gemfile and a sample configuration file is delivered in config/deploy.sample.rb.

Production

  • if you want to use newrelic you must have an account (http://newrelic.com/) and generate the config/newrelic.yml file by running newrelic install in the root folder of the application.

Licensing

SP-Gestion is released under the MIT License.