Skip to content

Commit

Permalink
📝 Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nmdra committed Oct 8, 2024
1 parent bd9c0ac commit f5aaf6f
Showing 1 changed file with 24 additions and 5 deletions.
29 changes: 24 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
- [Technologies](#technologies)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [System Design Diagram](#system-design-diagram)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
Expand All @@ -67,6 +68,18 @@
- **User Feedback**: Collect and analyze user feedback.
- **Product Catalog**: Comprehensive catalog of all products.

## System Design Diagram

<details>
<summary>Click Me</summary>

[![Diagram-2](https://github.com/user-attachments/assets/53bf02e1-cf86-4c12-8b64-8d97187b34dc)](https://excalidraw.com/#json=pIDjSIXEcYZ4rRh2eBW6B,SFv-6rNpKP1HBClEt2vTZw)

</details>


---

## Getting Started

### Prerequisites
Expand All @@ -78,6 +91,7 @@
### Installation
<details>
<summary>Click me</summary>

1. Clone the repository:
```bash
git clone https://github.com/yourusername/itp-project.git
Expand All @@ -94,14 +108,17 @@
npm install
npm run dev
```

</details>

### Docker Installation Guide

To run FarmCart using Docker, follow these steps:

<details>
<summary> 1. Install Docker </summary>
<summary>Click Me</summary>

1. Install Docker

- **For Windows and Mac**:
- Download Docker Desktop from [Docker's official website](https://www.docker.com/products/docker-desktop).
Expand All @@ -118,18 +135,15 @@ To run FarmCart using Docker, follow these steps:
sudo apt update
sudo apt install docker-ce
```
</details>
<details>
<summary>2. Verify Installation </summary>
1. Verify Installation
- After installing Docker, verify that it is installed correctly by running:
```bash
docker --version
```
- You should see the installed Docker version.
</details>
1. Run FarmCart with Docker Compose:
- Navigate to the root directory of the cloned repository:
Expand All @@ -147,6 +161,10 @@ To run FarmCart using Docker, follow these steps:
- Frontend: [http://localhost:3001](http://localhost:3001)
- API: [http://localhost:5001](http://localhost:5001)
</details>
---
## Docker Configuration
```yaml
Expand Down Expand Up @@ -188,3 +206,4 @@ networks:
mern-app:
driver: bridge

0 comments on commit f5aaf6f

Please sign in to comment.