-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(write-readme): write project readme file
- write detailed and comprehensive readme file [Finishes #14]
- Loading branch information
Showing
1 changed file
with
68 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 <image_name> . | ||
``` | ||
2. **Run the container** | ||
```sh | ||
docker run -p 8080:8080 <image_name> | ||
``` | ||
|
||
|
||
## 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) | ||
|