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:

Clone the Repository:

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

Install Dependencies:
```
npm install
```
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

Build the Docker Image:
```
docker build -t <image_name> .
```
Use Docker Compose to run Containers :
```
docker-compose up
```
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.

atlp-rwanda / dynamites-ecomm-be

readme