diff --git a/README.md b/README.md index afd20d0..8c44579 100644 --- a/README.md +++ b/README.md @@ -1,85 +1,124 @@ + +

+ + NestJS Logo + +

+ +

Shop Center πŸŽ‰

+

- Nest Logo + An open-source e-commerce backend built with NestJS πŸš€
+ Designed to provide a powerful, scalable, and clean architecture for modern online stores.

-# Shop Center πŸŽ‰ +--- -Welcome to Shop Center – an open-source e-commerce backend built with NestJS πŸš€. This project aims to provide a powerful, scalable, and clean architecture for your online store! πŸ’»πŸ›’ +## ✨ Features -## Features ✨ +- Fully customizable πŸ› οΈ +- Order management πŸ“¦ +- Product management 🏷️ +- User authentication πŸ” +- Cart management πŸ›’ +- Payment integration πŸ’³ +- RESTful API πŸ“‘ +- Unit & integration tests πŸ§ͺ +- Docker support 🐳 +- And much more 🌟 -* Fully customizable πŸ› οΈ -* Order management πŸ“¦ -* Product management 🏷️ -* User authentication πŸ”‘ -* Cart management πŸ›οΈ -* Payment integration πŸ’³ -* RESTful API πŸ“‘ -* Unit tests πŸ§ͺ -* Docker support 🐳 -* And much more! 🌟 +--- -## Tech Stack πŸ› οΈ +## πŸ› οΈ Tech Stack -* NestJS (Backend Framework) βš™οΈ -* MongoDB (Database) πŸ—„οΈ -* TypeScript (Language) πŸ–₯️ -* Docker (Containerization) πŸ‹ +- **NestJS** β€” Backend framework +- **MongoDB** β€” Database +- **TypeScript** β€” Main language +- **Docker** β€” Containerization -## How to Get Started πŸš€ +--- -1. Clone this repository: +## πŸš€ Getting Started + +### 1) Clone the repository ```bash - git clone https://github.com/AliDeWeb/Shop-Center.git +git clone https://github.com/AliDeWeb/Shop-Center.git ``` -2. Install dependencies: +### 2) Install dependencies ```bash - pnpm install +pnpm install ``` -3. Set up your environment variables in .env (check .env.example for reference). +### 3) Configure environment variables + +Create your `.env` file based on `.env.example`. -4. Run the development server: +### 4) Run the development server ```bash - pnpm run start:dev +pnpm run start:dev ``` -5. Visit the API and start building your e-commerce platform! 🌍 +### 5) Start building -## EnvsπŸͺ +Visit the API and start building your e-commerce platform 🌍 -
-* if you set `NODE_ENV=development`, you'll be able to access swagger document in `host/document`. -
-* you can download and import postman doc from `project-rootdir/postman`. -
-* you can run project with `docker-compose up`, before that you must edit envs in `project-rootdir/docker-compose.yaml`. +--- +## πŸͺ Environment Notes -## Running Tests πŸ§ͺ +- If you set `NODE_ENV=development`, Swagger documentation will be available at: -### This project includes both unit tests and integration tests to ensure the reliability and functionality of the application. +``` +host/document +``` -To run the tests, use the following command: +- You can download and import the Postman collection from: + +``` +project-rootdir/postman +``` + +- You can also run the project using Docker: + +```bash +docker-compose up +``` + +> Before running Docker, make sure to update the environment variables inside `project-rootdir/docker-compose.yaml`. + +--- + +## πŸ§ͺ Running Tests + +This project includes both **unit tests** and **integration tests** to ensure reliability and functionality. + +Run tests with: ```bash - pnpm run test +pnpm run test ``` -## Contributing 🀝 +--- + +## 🀝 Contributing -### This project is open source and contributions are always welcome! πŸ™Œ +Contributions are always welcome! πŸ™Œ -If you're excited about creating a great shopping experience and have ideas to improve Shop Center, feel free to fork the repo, open an issue, or submit a pull request! Together, we can make this project even better! πŸ’ͺ +If you're excited about building a better shopping experience and have ideas to improve **Shop Center**, feel free to: +- Fork the repository +- Open an issue +- Submit a pull request -## License πŸ“œ -This project is licensed under the MIT License. See the LICENSE file for more details. +Let’s build something awesome together πŸ’ͺ --- -This version now includes Docker setup instructions and test running details. Let me know if you need any further adjustments! +## πŸ“œ License + +This project is licensed under the **MIT License**. +See the `LICENSE` file for more details.