adammendoza / pensieve-api

🔭The Pensieve backend providing the API to review cards

Pensieve ·

"I use Pensieve. One simply siphons the excess thoughts from one's mind, pours them into the basin, and examines them at one's leisure. It becomes easier to spot patterns and links, you understand, when they are in this form."

Albus Dumbledore

This project contains the backend for Pensieve providing the API for accessing data using NodeJS and MongoDB.

Getting Started

Dependencies

• Node 4+
• MongoDB
• SendGrid

Installing

Clone this project and update path accordingly:

git clone [email protected]:pensieve-srs/pensieve-api.git
cd pensieve-api/

Install the dependencies:

yarn install

Copy the .env.example and update the variables to your settings:

cp .env.example .env.development.local

Start MongoDB instance:

mongod

Finally, start the server and watch for changes:

yarn run start:watch

Open up your browser and navigate to http://localhost:5000/docs/. You should see a Swagger API Docs interface.

Contributing

Roadmap

View the Project Roadmap which includes upcoming features, reported bugs, and other updates to the project.

Contributing Guide

All work happens directly on GitHub and contributions are welcomed!. Submit a Pull Request to introduce new code changes. Open an Issue to request a new feature or report a bug. Interested in contributing? Contact @nlaz for help to get started.

License

Pensieve is MIT licensed.