frisky

Open Source GraphQL API for Online Shows

Technical Stack/Framework Used

Built With

• Cloud Atlas - Database Service Provider
• Heroku - Platform Service Provider

Node.js Packages

• GraphQL
• Express
• Express GraphQL
• Mongoose

Usage

Prequisites

• Node.js - Chrome's V8 Javascript Engine
• MongoDB - NoSQL Database

Installation & Setup

• Install the packages mentioned in package.json file for getting all dependencies of the project.

npm install --save

• Getting the configuration ready
  Copy the .env.example file at the same location and save as .env

cp .env.example .env

• Starting the application (after starting MongoDB's mongod)

npm start

Linting

• Linting the code

npm run lint

• Fixing the linting issues

npm run fix

Import Database

• Import shows from sample data

mongoimport -d <database_name> -c shows seeds/shows.json

• Import episodes from sample data

mongoimport -d <database_name> -c episodes seeds/episodes.json

API Reference

Check out docs for more information!

Contribute

Contributing Guide coming soon!

Issues

Issues are managed via GitHub Issues.

License

This project is licensed under the Apache License. See the LICENSE file for details.