Configuration

• Ruby 2.x / Rails 4.2.5

• In config/database.yml (please, use makemepulse database for development)

    LOCAL_DB_USERNAME: "username"
    LOCAL_DB_PASSWORD: "password"
    LOCAL_DB_HOSTNAME: "hostname"

• In config/env.yml (or defined as ENV variables on the server)

    AWS_REGION: "AWS region for all elements"
    AWS_SECRET_KEY: "aws secret key"
    AWS_ACCESS_KEY_ID: "aws access key"
    AWS_ASSET_HOST: "CDN asset host"
    S3_BUCKET_NAME: "S3 bucket name"

Installation

• Install gems

  bundle install

• Generate your secret (for staging and production)

  rake secret

  then add it in your ENV variable as ENV["SECRET_KEY_BASE"]

Import the locales from GDRIVE

• Be sure to have a Google Drive file in config/translations.yml
• Run the command

  bundle exec rake i18n:import_translations
  

API documentation

The API documentation is generated with APIPIE. Once your application is running, check the documentation here

Install Git Flow localy

Cheat Sheet

  git flow init

• master branch is used only for releases.
• develop branch is used for the current state of the application.
• Development of new features starting from the develop branch.

Run application localy

• Launch Rails

  rails s