P2S Backend

Backend server for the p2s rugbyworks app

About

This project uses a REST api built with Feathers and a MongoDB database.

Getting Started

Prerequisites

• NodeJS
• Yarn or npm
• MongoDB

Installation

1. Clone this repository
2. Navigate to the folder with cd path/to/repo.
3. Run yarn or npm install to install dependencies.

Running the backend

1. Make sure MongoDB is running with mongod.
2. Add ENV_KEY as an environment variable with export ENV_KEY='secret key here'.
3. Run with yarn start or npm start for a production build or yarn dev/npm run dev for a development build.

Testing

Run yarn test or npm test and all your tests in the test/ directory will be run.

Database structure

License

Copyright (c) 2018

Licensed under the MIT license.