Skip to content

The Node Express server that handles the API between database and frontend

Notifications You must be signed in to change notification settings

joranquinten/snippy-api

Repository files navigation

Snippy API

This repository builds the Express backend for the Snippy application.

Getting started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

MongoDB

Make sure you have MongoDB installed and fill the following ENV variables:

  • DB_USER
  • DB_PASSWORD
  • DB_URL
  • MONGODB_URI= # Example: mongodb://localhost/local

Installing

Just run npm install to install all the dependencies.


Development

Running tests

Not done yet, be gentle!

Deployment

Not done yet, so only run locally 🙈


Background

Built with

  • Node
  • Express
  • MongoDB

Contributing

Easy-peasy! Notify the owner via an issue, submit a Pull Request and if you pass the sanity check, the PR will be merged. See Contributing.md for details.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Joran Quinten

License

This project is licensed under the MIT License.

About

The Node Express server that handles the API between database and frontend

Resources

Stars

Watchers

Forks

Packages

No packages published