Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 3.69 KB

README.md

File metadata and controls

54 lines (39 loc) · 3.69 KB
Raw

datablue

Datablue is a tool for collecting and aggregating open data, written using NodeJS and Express. It is being developed in conjunction with Proximap, a responsive web app for finding nearby public infrastructure, using drinking fountains as a showcase example. Check out water-fountains.org for more information on the overall project.

The project is open source under the GNU Affero General Public License, with a profit contribution agreement applying under restricted conditions. See COPYING for information.

Vision

Datablue will consist in a collection of scripts and data structures for collecting and manipulating data, which can be executed on a schedule to generate an always up-to-date consolidated dataset.

data processing View the data processing concept here. See the docs for planned components.

Running the project locally

  1. Requirements (make sure these are up to date)
  • NodeJS is a JavaScript runtime.
  • Git is a version control system you will need to have available as a command line executable on your path. A git integrated in your IDE will not be sufficient (and may cause issues).
  • Around 200MB of space on your disk. The project has development dependencies that are downloaded when you run > npm install (see point 3).
  1. Clone this repository to a local project directory > git clone https://github.com/water-fountains/datablue.git -b develop.
  2. Open a command line in the local project directory
    • Install required node packages: run > npm install. On Windows a warning will appear about an optional package that is required for Mac. This is normal but you can use > npm install --force if you don't want to see it.
    • Create a copy of the environment file > cp .envTEMPLATE .env
  3. In the newly copied .env file, set the following variable:
    • GOOGLE_API_KEY=[mykey] get a Google Maps API key and set it in the place of [mykey]. This is optional but required in order to see Google Street View images.
  4. Run it by running > npm run dev in the local project directory.
  5. Try it: Point you're browser to http://localhost:3000

Note: when you update your local project with git pull, make sure you run npm install again to update any packages that were changed.

Running the project in production mode:

warning: this assumes you have a private key privkey.pem and certificate cert.pem for ssl encryption located at

/etc/letsencrypt/live/water-fountains.org/

If this isn't the case, modify the init_symlink_server script in package.json.

Then run

> npm run init_symlink_server
> npm run compile
> pm2 start build/main.js --name "datablue"

Note: In production mode, the endpoint is available over https.

Contributing

Submit an issue for a feature request, architecture suggestion, or to discuss a modification you have made or would like to make.

If you would like to contribute directly to the code, fork this repo and make a pull request.

To get ideas for how to contribute, check out the repository issues.

To add a fountain property to be processed and made available by datablue, check this guide: Guide: include a new fountain property (operator id) in the processing pipeline