luxxi / open-data-velenje

Open Data Velenje

Open Data Velenje is a project where we have built an interface through which organizations can share their data in a simple way. With the help of Organicity experiment, we made it possible.

Getting started

Download Docker. If you are on Mac or Windows, Docker Compose will be automatically installed. On Linux, make sure you have the latest version of Compose. If you're using Docker for Windows on Windows 10 pro or later, you must also switch to Linux containers.

Run in this directory:

docker-compose up --build

The app will be running at http://localhost.

After that you should set your .env file based on our .env.example file. You will need to set:

LOCAL_OC_URL=your local OC Site url (example: http://88.212.147.244)
SECRET_KEY_BASE=devise secret key
DATABASE_PASSWORD=mongodb password
DATABASE_USER=mongodb username
DATABASE_NAME=name of your mongo database
ENVIRONMENT=development or production

Add Organicity data types:

Run rake db:seed to add all Organicity data types into database. This will also add some test organizations, so you can start experimenting with the app right away.

You can always edit the seeds.rb file to add your own test organizations or change the data types. You can find all current Organicity data types here.

Architecture

An organization creates a new account and provide data source (URL) and fetch type. Platform periodically pool data from the source, parse and store them in the database. Admin should approve organization by calling approve! function on your desired organization. This will display the organization on /organizations, allow the organization to sign in, add API documentation and also send a notification email to the organization stating that they were approved. The approved organization can access API configurator to set up field types and write a short description of a field. If oc_sync is set to the true platform will push organization data to Organicity (set LOCAL_OC_URL environment variable to point at your local OC Site). Organization data is available at endpoint http://localhost/api/v1/organizations/:organization_name