https://github.com/resource-watch/prep-api

Administrator and API for PREP application
https://github.com/resource-watch/prep-api

Last synced: 1 day ago
JSON representation

Administrator and API for PREP application

• Host: GitHub
• URL: https://github.com/resource-watch/prep-api
• Owner: resource-watch
• License: mit
• Created: 2016-06-10T07:59:55.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2021-02-24T12:48:29.000Z (over 3 years ago)
• Last Synced: 2024-04-14T09:38:31.340Z (7 months ago)
• Language: Ruby
• Homepage:
• Size: 6.24 MB
• Stars: 1
• Watchers: 12
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Administrator and API for [PREP application](https://github.com/resource-watch/prep-app)

[![Build Status](https://travis-ci.com/resource-watch/prep-api.svg?branch=master)](https://travis-ci.com/resource-watch/prep-api)

[![Test Coverage](https://api.codeclimate.com/v1/badges/59331ed7504c0e00db4c/test_coverage)](https://codeclimate.com/github/resource-watch/prep-api/test_coverage)

![PREP](screenshot.png?raw=true "The Climate Partnership for Resilience and Preparedness")

## Install

Requirements:

* NodeJS

* Ruby 2.4.1

* Yarn

The app rides on [Ruby on Rails](http://rubyonrails.org).

Clone repo:

```bash

$ git clone https://github.com/resource-watch/prep-api

$ cd prep-manager

```

We recommend managing your Ruby installation through

[rbenv](https://github.com/sstephenson/rbenv). It's just an easy way to

run multiple Ruby versions for different applications:

```bash

$ rbenv install 2.4.1

$ rbenv local 2.4.1

```

Install gem dependencies using [Bundler](http://bundler.io/)

```bash

$ bundle install

```

Set up database:

```bash

$ rake db:create

$ rake db:migrate

$ rake db:seed

```

## Usage

Duplicate `.env.sample`, rename to `.env` and finally set your options in that file.

After install it, we can run server runing:

```bash

bundle exec rails server

```

## 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

## LICENSE

[MIT](LICENSE)