https://github.com/resource-watch/rw_chart

https://github.com/resource-watch/rw_chart

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/resource-watch/rw_chart
• Owner: resource-watch
• Created: 2016-10-19T10:23:33.000Z (about 8 years ago)
• Default Branch: develop
• Last Pushed: 2016-10-19T15:42:42.000Z (about 8 years ago)
• Last Synced: 2024-04-09T11:25:06.480Z (7 months ago)
• Language: Ruby
• Size: 72.3 KB
• Stars: 0
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# Resource Watch Chart Service

[![Build Status](https://travis-ci.org/resource-watch/rw_chart.svg?branch=develop)](https://travis-ci.org/resource-watch/rw_chart) [![Code Climate](https://codeclimate.com/github/resource-watch/rw_chart/badges/gpa.svg)](https://codeclimate.com/github/resource-watch/rw_chart)

TODO: Write a project description

## Installation

Requirements:

* Ruby 2.3.1 [How to install](https://gorails.com/setup/osx/10.10-yosemite)

* PostgreSQL 9.4+ [How to install](http://exponential.io/blog/2015/02/21/install-postgresql-on-mac-os-x-via-brew/)

## Usage

### Natively

First time execute:

    bin/setup

    Or install global dependencies:

    gem install bundler

    bundle install

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

    bundle exec rake db:create

    bundle exec rake db:migrate

To run application:

    bundle exec rails server

### Using Docker

### Requirements for docker

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

- [Docker](https://www.docker.com/)

- [docker-compose](https://docs.docker.com/compose/)

## Executing

Start by checking out the project from github

```

git clone https://github.com/Vizzuality/rw_chart.git

cd rw_chart

```

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

To setup the project on docker:

```

./service develop

```

To run the tests on docker:

```

./service test

```

## TEST

  Run rspec:

    bin/rspec

## Contributing

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

### BEFORE CREATING A PULL REQUEST

  Please check all of [these points](https://github.com/resource-watch/rw_chart/blob/master/CONTRIBUTING.md).