Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/talha4t/e-commerce
e-commerce backend api
https://github.com/talha4t/e-commerce
integration-testing nestjs nodejs postgresql prisma-orm redis
Last synced: 21 days ago
JSON representation
e-commerce backend api
- Host: GitHub
- URL: https://github.com/talha4t/e-commerce
- Owner: talha4t
- Created: 2024-08-08T08:40:31.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-09-20T08:45:09.000Z (5 months ago)
- Last Synced: 2024-11-13T01:41:10.116Z (3 months ago)
- Topics: integration-testing, nestjs, nodejs, postgresql, prisma-orm, redis
- Language: TypeScript
- Homepage:
- Size: 1000 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# E-Commerce Backend
This project is a robust e-commerce backend built with Node.js, NestJS, PostgreSQL, and Docker. It provides a scalable and efficient foundation for building modern e-commerce applications.
## Table of Contents
- [Prerequisites](#prerequisites)
- [Getting Started](#getting-started)
- [Environment Setup](#environment-setup)
- [Installation](#installation)
- [Database Setup](#database-setup)
- [Running the Application](#running-the-application)
- [Testing](#testing)
- [Docker](#docker)
- [CI/CD](#cicd)
- [API Documentation](#api-documentation)
- [Contributing](#contributing)
- [License](#license)
## Prerequisites
Before you begin, ensure you have the following installed:
- Node.js (v22.x)
- npm (comes with Node.js)
- Docker and Docker Compose
- PostgreSQL (if not using Docker)
## Getting Started
### Environment Setup
1. Clone the repository:
```
git clone https://github.com/talha4t/e-commerce.git
cd e-commerce-backend
```
2. Copy the example environment file and update it with your settings:
```
cp .env.example .env
```
3. Update the `.env` file with your specific configuration:
- Set the `DATABASE_URL` to match your PostgreSQL setup
- Configure JWT secrets and expiry times
- Add Cloudinary credentials if using image uploads
### Installation
Install the project dependencies:
```
npm install
```
### Database Setup
If you're not using Docker, ensure your PostgreSQL server is running and the database is created. Then run the migrations:
```
npm run migrate:dev
```
## Running the Application
To start the application in development mode:
```
npm run start:dev
```
For production:
```
npm run build
npm run start:prod
```
## Testing
Run the test suite:
```
npm test
```
For integration tests:
```
npm run test:int
```
## Docker
To run the application using Docker:
1. Start the PostgreSQL container:
```
docker-compose up -d
```
2. Build and run the application:
```
docker build -t e-commerce .
docker run -p 3000:3000 --env-file .env e-commerce
```
## CI/CD
This project uses GitHub Actions for continuous integration. The workflow is defined in `.github/workflows/nodejs.yml`. It runs on pushes to `master` and `dev` branches, and on pull requests to these branches.
The CI process includes:
- Setting up Node.js and PostgreSQL
- Installing dependencies
- Building the project
- Running Prisma migrations
- (Commented out) Running integration tests
## API Documentation
API documentation is generated using Swagger. Once the application is running, you can access the Swagger UI at:
```
http://localhost:3000/api
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the [UNLICENSED] License.