Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 84 additions & 45 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,85 +1,124 @@

<p align="center">
<a href="http://nestjs.com/" target="_blank">
<img src="https://nestjs.com/img/logo-small.svg" width="120" alt="NestJS Logo" />
</a>
</p>

<h1 align="center">Shop Center 🎉</h1>

<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>
An open-source <b>e-commerce backend</b> built with <b>NestJS</b> 🚀<br/>
Designed to provide a powerful, scalable, and clean architecture for modern online stores.
</p>

# 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 🌍

<br/>
* if you set `NODE_ENV=development`, you'll be able to access swagger document in `host/document`.
<br/>
* you can download and import postman doc from `project-rootdir/postman`.
<br/>
* 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.
Loading