APIFranchiseExample

Quick Tutorial: How to Run the Node.js App with MongoDB

This tutorial will guide you step-by-step to run the Node.js application with MongoDB Atlas (cloud-hosted).

---

Prerequisites

1. Node.js: Make sure Node.js is installed on your machine.

   • Download Node.js

2. MongoDB Atlas:

   • Obtain your MongoDB connection URI. Add it to the .env file.

3. Postman (optional): To test HTTP requests.

   • Download Postman

---

Instructions to Run the App

1. Clone the Project

git clone https://github.com/Kalugy/APIFranchiseExample.git
cd franchise-api

npm install

2. Configure Environment Variables Add MongoDB credentials and other environment variables to your .env file.

3. Run the Server

npm run dev

4. Test Endpoints in Postman Use Postman to test the API. Link to Postman

5. Optional run with docker

docker-compose up --build 

Deploy Pdn Links

Link to PDN Backend

Note

• Task.md: Show an overview of task with acceptation criteria.