BenarID is a crowdsourced, collaborative Indonesian news rating app.
This is the repo for the server component for the API and website.
This is still a work in progress!
We whitelist news portals to make sure that BenarID only works on valid articles. We don't want it to work on every page you visit (and our DB would explode 😄).
See this directory for a list of currently whitelisted portals.
Thanks for wanting to contribute! This section will explain how to get up and running on developing this project. There are several ways you can contribute.
Found a bug? Requesting a feature? Want to add a news portal to BenarID whitelist? Fire up an issue!
If it's a bug, please provide the steps required to reproduce it as detailed as you can. Help us to help you.
We need all the help we can get, so if you're a fellow developer, this section is for you.
For the server, we use Elixir and the Phoenix web framework, with PostgreSQL DB.
Make sure you have these installed:
- Elixir >= 1.3.4
- PostgreSQL >= 9.6
- Node.js >= 6.9.1
- Yarn package manager
To setup your dev environment:
- Clone this repo and cd into the directory
cp .env.example .envand fill out the details.- Export the env variables with
export $(cat .env | xargs) - Install dependencies with
mix deps.getandyarn - Create and migrate your database with
mix ecto.create && mix ecto.migrate - Setup the data with
mix do benarid.portal.sync --all, benarid.rating.sync - Start the server with
mix phoenix.server
The server will then be running at localhost:4000
To run the tests, use:
$ mix test
The license is still being worked on. Until then, all rights reserved.