Plotline Ecommerse Based API Backend

Table of Contents

• Prerequisites
• Installation & Setup
• Starting the Application
• API Endpoints
• Contributing
• License

Prerequisites

To run this project, you'll need:

• A laptop or computer.
• Node.js and NPM.
• A MySQL database.

Installation & Setup

1. Clone the repository:

git clone https://github.com/your-username/ecommerce-cart-management.git
cd ecommerce-cart-management

2. Install dependencies:

    npm install

3. Database Setup:

• Create a MySQL database and take note of your connection configurations.
• Rename .env.example to .env and fill in your database details:

      DB_HOST=your_host
      DB_USER=your_user
      DB_PASSWORD=your_password
      DB_DATABASE=your_database_name
      JWT_TOKEN_SECRET=your_secret_key

4. Database Migration:

• Use the provided SQL scripts to set up the required tables in your database.

5. Other configurations:

• Ensure to adjust other configurations in the .env or other config files as necessary, such as JWT secrets.

Starting the Application

1. Start the app:

     node app.js

For Admin API Use Below Secret Key

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiJBZG1pblBsb3QiLCJyb2xlIjoiYWRtaW4ifQ.yUeYj4k6HOw5sXr0ztDA14URkr7S37XfcIEXOXgT2E8

The application should now be running on 'http://localhost:3000'.

API Endpoints

    '/AddToCart' - Add Item to users cart.
    '/Checkout' - Confirms the order and revert changes.
    '/getAllOrders' - Shows total transaction performed.
    '/forgotPassword' - Change Password For Existing User.

Full Documentation

Contributing

• Wish to contribute? Feel free to open a pull request. For significant changes, kindly open an issue first to deliberate what you'd prefer to change.

License

• This project is open-source and available under the MIT License.