From 3ca215d1fcd1bfd5cef4bbee6620a513fbc107df Mon Sep 17 00:00:00 2001 From: jkarenzi Date: Wed, 5 Jun 2024 19:42:54 +0200 Subject: [PATCH] chore(write-readme): write project readme file - write detailed and comprehensive readme file [Finishes #14] --- README.md | 69 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 68 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index baa92832..c696f4dd 100644 --- a/README.md +++ b/README.md @@ -1 +1,68 @@ -## Dynamites E-commerce Web +# Dynamites UI + +## Overview + +Welcome to Dynamites frontend application! This project provides an appealing user interface for the dynamites e-commerce application. It allows users to browse products, place orders, manage their account, and perform other e-commerce-related activities. + + +## Installation + +To get started with the Dynamites frontend app, follow these simple steps: + +1. **Clone the Repository**: + + ```bash + git clone https://github.com/atlp-rwanda/dynamites-ecomm-fe.git + ``` + +2. **Install Dependencies**: + + ```bash + npm install + ``` + +3. **Run the Development Server**: + ```bash + npm run dev + ``` + +## Testing + +- Run tests + + ```bash + npm run test + ``` + +- Run tests with coverage + + ```bash + npm run test:ci + ``` + +## Docker + +Before you run that commands you must have docker installed in your PC + +1. **Build the Docker Image:** + ```sh + docker build -t . + ``` +2. **Run the container** + ```sh + docker run -p 8080:8080 + ``` + + +## Authors + +- [Manzi Karenzi](https://github.com/jkarenzi) +- [Leo Rurangwa](https://github.com/wayneleon1) +- [Tresor Xavier](https://github.com/13XAVI) +- [Sangwa Cedric](https://github.com/Dawaic6) +- [Ambroise Muhayimana](https://github.com/ambroisegithub) +- [Eric Niyibizi](https://github.com/niyibi250) +- [Bernard Niyomugabo](https://github.com/niyobern) +- [Bertrand Shema](https://github.com/bertrandshema) +- [Pray Eddy Shimwa](https://github.com/EddyShimwa) +