Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/resource-watch/resource-watch-manager
https://github.com/resource-watch/resource-watch-manager
Last synced: 1 day ago
JSON representation
- Host: GitHub
- URL: https://github.com/resource-watch/resource-watch-manager
- Owner: resource-watch
- License: mit
- Created: 2017-01-18T12:08:38.000Z (almost 8 years ago)
- Default Branch: dev
- Last Pushed: 2024-01-09T09:45:42.000Z (10 months ago)
- Last Synced: 2024-04-14T09:38:31.959Z (7 months ago)
- Language: Ruby
- Size: 1.99 MB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Resource Watch site manager microservice for the RW API
[](https://travis-ci.com/resource-watch/resource-watch-manager)
[](https://codeclimate.com/github/resource-watch/resource-watch-manager/test_coverage)
Content API microservice for Resource Watch website
Stores information on dashboards, profiles, etc.
If you are looking for the RW dataset API, you can find it [here](https://github.com/resource-watch/dataset)
# Setup
## Requirements
### Native execution
* [Ruby 3.1.2+](https://www.ruby-lang.org/en/)
* [Bundler](https://bundler.io/)
* [Postgres](https://www.postgresql.org/)
### Docker
* [Docker](https://www.docker.com/)
* [Docker compose](https://docs.docker.com/compose/)
Dependencies on other Microservices:
- [Widget](https://github.com/resource-watch/widget)
## Installation process:
### Native execution
Copy `.env.sample` to `.env` and fill in the necessary values:
- RAILS_ENV: `development`|`production`
- SECRET_KEY_BASE: rails secret. [read more](https://medium.com/@michaeljcoyne/understanding-the-secret-key-base-in-ruby-on-rails-ce2f6f9968a1)
- RW_API_URL: URL of the RW API. Usually you want `https://api.resourcewatch.org` here
- APIGATEWAY_URL: URL of the RW API gateway. Usually you want `https://api.resourcewatch.org` here
- POSTGRES_PORT_5432_TCP_ADDR: Network address of your Postgres database server
- POSTGRES_PORT_5432_TCP_PORT: Network port of your Postgres database server
- POSTGRES_USER: Username of your Postgres database server
- POSTGRES_PASS: Password of your Postgres database server
- POSTGRES_DATABASE: Name of your database
- GATEWAY_URL: RW API gateway URL (microservice mode only)
- MICROSERVICE_TOKEN: Microservice auth token (microservice mode only)
Install the ruby dependencies:
```bash
bundle install
```
To start the development application server, run:
```bash
bundle exec rails server
```
### Docker
TODO: add more detailed docker installation instructions
```bash
./entrypoint.sh start
```
# Tests
```bash
RAILS_ENV=test bundle exec rake db:drop db:create db:schema:load
bundle exec rspec spec
```