Update README.md

Signed-off-by: OldSlayer1903 <[email protected]>

Author: OldSlayer1903

README.md

@@ -1,92 +1,113 @@
+# StoreZero: E-Commerce Application
+
 <p align="center">
   <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
 </p>
 
 [circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
 [circleci-url]: https://circleci.com/gh/nestjs/nest
 
-  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
+  <p align="center">A robust e-commerce application built with **NestJS** , **Prisma** , **PostgreSQL** , and **TypeScript** . This project includes user authentication, CRUD operations, and more.</p>
     <p align="center">
 <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
 <a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
 <a href="https://github.com/building-for-fun/StoreZero/actions/workflows/secret-scan.yml" target="_blank"><img src="https://github.com/building-for-fun/StoreZero/actions/workflows/secret-scan.yml/badge.svg" alt="Secret Scan" /></a>
 
-</p>
-  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
-  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+---
 
-## Description
+## 🚀 Tech Stack
 
-[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+![NestJS](https://img.shields.io/badge/NestJS-E0234E?style=for-the-badge&logo=nestjs&logoColor=white)
+![Prisma](https://img.shields.io/badge/Prisma-2D3748?style=for-the-badge&logo=prisma&logoColor=white)
+![PostgreSQL](https://img.shields.io/badge/PostgreSQL-336791?style=for-the-badge&logo=postgresql&logoColor=white)
+![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=for-the-badge&logo=typescript&logoColor=white)
+![Docker](https://img.shields.io/badge/Docker-2496ED?style=for-the-badge&logo=docker&logoColor=white)
+![Jest](https://img.shields.io/badge/Jest-C21325?style=for-the-badge&logo=jest&logoColor=white)
 
-## Project setup
+---
 
-```bash
-$ npm install
-```
+## 🛠 Installation
 
-## Compile and run the project
+1. **Clone the repository**:
+   ```bash
+   git clone https://github.com/building-for-fun/StoreZero.git
+   cd StoreZero
+   ```
 
-```bash
-# development
-$ npm run start
+Install dependencies:
 
-# watch mode
-$ npm run start:dev
+  ```bash
+    npm install 
+  ```
 
-# production mode
-$ npm run start:prod
-```
+Install NestJS CLI (if not already installed):
 
-## Run tests
+  ```bash
+  npm install -g @nestjs/cli
+  ```
 
-```bash
-# unit tests
-$ npm run test
+<hr/>
+
+🔑 Environment Variables
+Copy the `.env.example` file to .env:
+
+  ```bash
+  cp .env.example .env
+  ```
+
+Update the .env file with your configuration (e.g., database URL, JWT secret, etc.).
 
-# e2e tests
-$ npm run test:e2e
 
-# test coverage
-$ npm run test:cov
+<hr/>
+
+▶️ Running the Application
+Without Docker
+
+Start the application:
+
+```bash
+npm run start:dev
 ```
 
-## Deployment
+The application will be available at http://localhost:3000.
 
-When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.
 
-If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:
+With Docker
+Build and start the Docker containers:
 
 ```bash
-$ npm install -g mau
-$ mau deploy
+docker-compose up --build
 ```
 
-With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.
+The application will be available at http://localhost:3000.
+
 
-## Resources
+<hr/>
 
-Check out a few resources that may come in handy when working with NestJS:
+📦 Prisma Migrations
 
-- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
-- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
-- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
-- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
-- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
-- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
-- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
-- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).
+Run Prisma migrations:
 
-## Support
+  ```bash
+  npx prisma migrate dev --name <migration-name>
+  ```
 
-Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+Generate Prisma client:
 
-## Stay in touch
+  ```bash
+  npx prisma generate
+  ```
 
-- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
-- Website - [https://nestjs.com](https://nestjs.com/)
-- Twitter - [@nestframework](https://twitter.com/nestframework)
+<hr/>
+
+🧪 Running Tests
+Run the tests using Jest:
+
+```bash
+npm run test
+```
 
-## License
+<hr/>
 
-Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
+📄 License 
+This project is licensed under the MIT License.