sebkzn / workshop_nodejs_api

Simple REST API build with NodeJS and Express as part of an OpenClassroom exercise

workshop_nodejs_api

Simple REST API build with NodeJS, Express, and MongoDB as part of an OpenClassroom exercise

Goals

the exercise consisted of creating a REST API (as a CRUD app) with NodeJS and Express to communicate with a MongoDB database.
More details and tests instructions can be found here here.

Requirements

• nodejs and npm (https://nodejs.org/)
• npm packages express, body-parser, nodemon, dotenv, mongoose
• a MongoDB server (https://www.mongodb.com/)
• a .env file in the api directory with NODE_ENV, PORT, and MONGO_URL variables (example)

Installation

$ npm install -g nodemon # may be run as sudo
$ git clone https://github.com/sebkzn/workshop_nodejs_api.git
$ cd workshop_nodejs_api/api
$ npm install

Run

To start the API, just run the command below from the api directory :

$ nodemon server

The service will now run on localhost, listening on the port you specified in your .env file