Open Tourism Platform

Release History:

If you want to get involved, check out the contributing file.

See the API docs here. See the guide for app developers using OAuth here.

What?

An open backend to help support and facilitate the creation of apps and websites aimed at developing tourism in Nazareth.

Primarily, and during initial phases, this will be an open database of places, products, services, events and reviews.

Local install instructions

Requirements: MongoDB

git clone https://github.com/foundersandcoders/open-tourism-platform.git && cd open-tourism-platform
npm i

Create a .env file containing three variables in the root directory:

MONGODB_URI_DEV=mongodb://localhost/open-platform-dev
MONGODB_URI_TEST=mongodb://localhost/open-platform-test
JWT_SECRET=devEnvironmentSecret

Ensure mongodb is running.

Run a dev server

npm run dev

Test scripts

# To run the tests:
npm test

# To run the istanbul coverage:
npm run coverage