Topman-14 / hng_stage_two

Simple REST API with CRUD functionalities

HNG stage two REST API

• My slack name is Topman.
  
• This project is my stage two submission; a RESTful API for managing person records.
  
• I'm using a render free plan to host this API, so it will be slow to start after inactivity for a period of time.

Languages and Tools

• Node.js
• Express.js
• MongoDB (with Mongoose)

Installation

1. Clone the repository:

   git clone https://github.com/Topman-14/hng_stage_two.git
   

2. Navigate to the project directory:

   cd hng_stage_two
   

3. Install dependencies:

   npm install
   

4. Create a .env file and configure the MongoDB connection and port number:

   PORT=4000
   MONGO_URI="<your_connection_string>"

5. Start the server:

   npm start
   

The API will be accessible at http://localhost:4000/api/

API Documentation

For detailed API docs and use cases, refer to the documentation

UML Diagrams