Sustainable Cities API

DOCUMENTATION

API Documentation

USAGE

Start by checking out the project from github

git clone https://github.com/Vizzuality/sustainable_cities.git
cd sustainable_cities

You can either run the application natively, or inside a docker container.

NATIVELY

REQUIREMENTS

• Ruby version: 2.4.0
• PostgreSQL 9.4+ How to install

Just execute the script file in bin/setup

Depends on Sustainable Cities repository

or install the dependencies manually:

Install global dependencies:

gem install bundler

Install gems:

bundle install

Set up the database

cp config/database.yml.sample config/database.yml
cp env.sample .env

bundle exec rake db:create
bundle exec rake db:migrate

Load sample data:

bundle exec rake db:seed

Run application:

bin/rails s

USING DOCKER

REQUIREMENTS FOR DOCKER

If You are going to use containers, You will need:

• Docker
• docker-compose

EXECUTING

To setup the project on docker:

./service develop

To run the tests on docker:

./service test

TEST

To run the tests on docker:

./service test

Run rspec:

  bin/rspec

DEPLOYMENT

To deploy the API to staging environment, just execute: cap staging deploy

CONTRIBUTING

BEFORE CREATING A PULL REQUEST

Please check all of these points.

1. Fork it!
2. Create your feature branch: git checkout -b feature/my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin feature/my-new-feature
5. Submit a pull request :D