tajbaba999 / assgiment

MedPlus API

MedPlus is an Express.js application designed for managing pharmacies and medicines. It provides a set of RESTful APIs for CRUD operations on pharmacies and medicines, user management, and image uploads through Cloudinary. The API is documented with Swagger for easy exploration and testing.

Table of Contents

• MedPlus API
  • Table of Contents
  • Introduction
  • Prerequisites
  • Installation
    • 1. Clone the Repository
    • 2. Install Dependencies
    • 3.Set Up Environment Variables
    • 4. Run the Application
    • 5. Access API Documentation
    • 6. Test API Endpoints

Introduction

MedPlus API provides endpoints for managing pharmacies and medicines. It includes functionality for creating, reading, updating, and deleting pharmacy and medicine records. The API also supports user authentication and image uploads through Cloudinary. The API documentation is available via Swagger UI.

Prerequisites

To run this application locally, you will need:

• Node.js (v14 or higher)
• npm or yarn
• MongoDB (You can use MongoDB Atlas for cloud-based MongoDB)
• Cloudinary account

Installation

1. Clone the Repository

Clone the repository to your local machine using the following command:

git clone https://github.com/tajbaba999/assgiment.git
cd assgiment

2. Install Dependencies

Navigate to the project directory and install the required dependencies:

npm install
# or
yarn install

3.Set Up Environment Variables

Create a .env file in the root directory of the project with the following contents:

PORT=3000
MONGODB_URI=<your_mongodb_connection_string>
CLOUDINARY_CLOUD_NAME=<your_cloudinary_cloud_name>
CLOUDINARY_API_KEY=<your_cloudinary_api_key>
REDIS_URL=<url>

4. Run the Application

Start the application using the following command:

npm start
# or
npm run dev

The application will be available at http://localhost:3000.

5. Access API Documentation

Head over to http://localhost:3000/api-docs to view the API documentation generated by Swagger.

6. Test API Endpoints

The best way to test the API endpoints is to import the Medlr.postman_collection.json file into Postman. You can download the file from the following link:

Medlr.postman_collection.json