Dynamites API

Overview

Welcome to Dynamites API! This project provides the backend API for the dynamites e-commerce application. It allows users to browse products, place orders, manage their account, and perform other e-commerce-related activities.

Documentation

Find the API documentation at https://dynamites-ecomm-be.onrender.com/api-docs

Installation

To get started with Dynamites API, follow these simple steps:

1. Clone the Repository:

   git clone https://github.com/atlp-rwanda/dynamites-ecomm-be.git

2. Install Dependencies:

   npm install

3. Run the Development Server:

   npm run dev

Testing

• Run tests

  npm run test

• Run tests with coverage

  npm run test:ci

Docker

Before you run that commands you must have docker installed in your PC

1. Build the Docker Image:

   docker build -t <image_name> .

2. Use Docker Compose to run Containers :

   docker-compose up

3. Stop the Running Containers:
   • If running with Docker Compose:

     docker-compose down

Usage

Once the development server is running, you can interact with the API using HTTP requests.

Authors

• Manzi Karenzi
• Leo Rurangwa
• Tresor Xavier
• Sangwa Cedric
• Ambroise Muhayimana
• Eric Niyibizi
• Bernard Niyomugabo
• Bertrand Shema
• Pray Eddy Shimwa