Gamification Platform Backend

About the project

This is a standalone backend for Gamification platform built by Codebrahma based on Node (Hapi JS) and GraphQL. MongoDB will be used as backend.

Bootstraped using Hapi Starter Kit | Hapi based REST application boilerplate, uses async/await

Requirements

• node.js >= 8.4.0
• yarn >= 0.27.5
• docker
  • Docker is optional and is required only if you want to develop and deploy using Docker

Getting Started

# Install dependencies
$ yarn

# Start Server
# Set environment variables defined in `config/custom-environment-variables.json`
$ yarn start

# Run Tests
$ yarn test

Docker

Development

# copy sample.dev.env to dev.env
$ cp bin/sample.dev.env bin/dev.env

# Start Server
$ bash bin/development.sh

Tests

# copy sample.test.env to test.env
$ cp bin/sample.test.env bin/test.env

# Run Tests
$ bash bin/test.sh

More Tasks

# Run lint
yarn lint

Documentation

• hapi-swagger self documents all the APIs.
• Visit http://localhost:3030/documentation to access the documentation after starting the server.

Issues

Please feel free to open an issue if you can have any questions or trouble using this starter kit.

Contributions

Contributions are all welcome and encouraged.

Follow this guide to learn how to contribute.

License

This project is licensed under the MIT License