Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alideweb/shop-center
online shop backend app developed by nestjs ;)
https://github.com/alideweb/shop-center
Last synced: about 1 month ago
JSON representation
online shop backend app developed by nestjs ;)
- Host: GitHub
- URL: https://github.com/alideweb/shop-center
- Owner: AliDeWeb
- Created: 2024-12-16T09:05:45.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-16T09:08:23.000Z (about 1 month ago)
- Last Synced: 2024-12-16T10:22:18.489Z (about 1 month ago)
- Language: TypeScript
- Size: 70.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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 ✨
* Fully customizable 🛠️
* Order management 📦
* Product management 🏷️
* User authentication 🔑
* Cart management 🛍️
* Payment integration 💳
* RESTful API 📡
* Integration and unit tests 🧪
* Docker support 🐳
* And much more! 🌟
## Tech Stack 🛠️
* NestJS (Backend Framework) ⚙️
* MongoDB (Database) 🗄️
* TypeScript (Language) 🖥️
* Docker (Containerization) 🐋
## How to Get Started 🚀
1. Clone this repository:
```bash
git clone https://github.com/AliDeWeb/Shop-Center.git
```
2. Install dependencies:
```bash
pnpm install
```
3. Set up your environment variables in .env (check .env.example for reference).
4. Run the development server:
```bash
pnpm run start:dev
```
5. Visit the API and start building your e-commerce platform! 🌍
## Envs Example 🪝
```ts
NODE_ENV=development | production
PORT=3000
DB_URL="mongodb url"
JWT_SECRET_KEY=12345678
JWT_ACCESS_TOKEN_EXPIRES_IN=15m
JWT_ACCESS_REFRESH_EXPIRES_IN=7d
BCRYPT_SALT=10
```
before running e2e tests notice that you can edit `/test/test-utils.ts` file and change the test db uri.
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`.
## Running Tests 🧪
### This project includes both unit tests and integration tests to ensure the reliability and functionality of the application.
To run the tests, use the following command:
```bash
pnpm run test
```
For e2e tests, you can use:
```bash
pnpm run test:e2e
```
## Contributing 🤝
### This project is open source and 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! 💪
## License 📜
This project is licensed under the MIT License. See the LICENSE file for more details.
---
This version now includes Docker setup instructions and test running details. Let me know if you need any further adjustments!