Skip to content

Commit

Permalink
chore(write-readme): write project readme file
Browse files Browse the repository at this point in the history
- write detailed and comprehensive readme file

[Finishes #14]
  • Loading branch information
jkarenzi committed Jun 6, 2024
1 parent caf0955 commit 3ca215d
Showing 1 changed file with 68 additions and 1 deletion.
69 changes: 68 additions & 1 deletion README.md
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)

0 comments on commit 3ca215d

Please sign in to comment.