This repository contains a simple demo API built with NodeJS (/app folder). The API is used to manage users in a MongoDB database.

This application was developed using ExpressJS. MongoDB was used for persisting data with Mongoose as ORM.

• Start up your terminal (or command prompt).
• Ensure that you've docker and git installed on your PC.
• Clone the repository by entering the command git clone https://github.com/kulgee001/UserManager in the terminal.
• Navigate to the project folder using cd UserManager on your terminal (or command prompt).
• Create a .env file similar to the .env-sample file. Set DB_URL='mongodb://mongodb:27017' and PORT=3000. It is essential you create this file before running the application.
• Then execute the run.sh script with the command bash run.sh
• Your app will be available at http://localhost:3000

The API only has one endpoint which is the /users endpoint for saving users to the database. The endpoint works with the HTTP verbs: POST, GET, PUT, DELETE.

• POST /users
• INPUT:

name: John Doe
email: [email protected]
password: johndoe

• HTTP Status: 201: created
• JSON data

{
  "_id": "59071791b0lkscm2325794",
  "name": "John Doe",
  "email": "[email protected]",
  "password": "johndoe",
  "__v": 0
}

• GET /users

[
    {
        "_id": "59071791b0lkscm2325794",
        "name": "John Doe",
        "email": "[email protected]",
        "password": "johndoe",
        "__v": 0
    }
]

• GET /users/:id

{
    "_id": "59071791b0lkscm2325794",
    "name": "John Doe",
    "email": "[email protected]",
    "password": "johndoe",
    "__v": 0
}

• DELETE /users/:id

User John Doe was deleted

• PUT /users/:id
• INPUT:

name: Jane Doe
email: [email protected]
password: janedoe

• HTTP Status: 200: OK
• JSON data

{
  "_id": "59071791b0lkscm2325794",
  "name": "Jane Doe",
  "email": "[email protected]",
  "password": "janedoe",
  "__v": 0
}

Olajide Bolaji 'Nuel - Software Developer at Andela