Skip to content

ChinnaDevelopers/Coupon-Management-System

Repository files navigation

Coupons API

This is a RESTful API for managing coupons.

Features

  • Register and Login the user
  • Create, update, access and use coupons
  • Create api-keys to access coupons (can be used as third party apis)

Installation

  1. Clone the repository:

    git clone https://github.com/ManoharNaidu/Coupon-API.git
  2. Install the dependencies:

    npm install
  3. Set up the database:

    • Create a MongoDB database of yours and use URI in env to access
  4. Start the server:

    npm run dev

API Documentation

For detailed information on how to use the API, please refer to the /api-docs route after starting the server.

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.