Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thakurdiwakar/nestjs-product-management
A NestJS-based product management API for an online store. Manage products, retrieve product details, update, and delete products.
https://github.com/thakurdiwakar/nestjs-product-management
api nestjs postgresql yarn
Last synced: 2 days ago
JSON representation
A NestJS-based product management API for an online store. Manage products, retrieve product details, update, and delete products.
- Host: GitHub
- URL: https://github.com/thakurdiwakar/nestjs-product-management
- Owner: thakurdiwakar
- Created: 2023-10-14T14:20:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-15T16:30:27.000Z (about 1 year ago)
- Last Synced: 2024-11-12T03:39:00.175Z (2 months ago)
- Topics: api, nestjs, postgresql, yarn
- Language: TypeScript
- Homepage:
- Size: 110 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NestJS Product Management
This repository contains a NestJS-based product management API for an online store. It provides essential endpoints for managing products, including creating, retrieving, updating, and deleting product information. This repository serves as the backend component of the online store application.
## Getting Started
These instructions will help you set up and run the project on your local machine for development and testing purposes.
### Prerequisites
Before you begin, make sure you have the following software installed:
- [Node.js](https://nodejs.org/) (v14 or higher)
- [npm](https://www.npmjs.com/)
### Installation
1. Clone this repository to your local machine:
```shell
git clone https://github.com/your-username/nestjs-product-management.git
```
2. Navigate to the project directory:
```shell
cd nestjs-product-management
```
3. Install the project dependencies:
```shell
npm install
```
### Usage
To start the NestJS application, use the following command:
```shell
npm run start
```
By default, the application runs on `http://localhost:3000`.
### API Endpoints
- `GET /products`: Retrieve a list of all products.
- `GET /products/{id}`: Retrieve details of a specific product by ID.
- `POST /products`: Create a new product.
- `PATCH /products/{id}`: Update an existing product.
- `DELETE /products/{id}`: Delete a product by ID.
For more details on how to use these endpoints, refer to the [API documentation](docs/API.md).
## Contributing
We welcome contributions to improve this project! If you'd like to contribute, please follow our [Contribution Guidelines](CONTRIBUTING.md).
## Acknowledgments
- NestJS: [https://nestjs.com/](https://nestjs.com/)
- GitHub: [https://github.com/](https://github.com/)
## Contact
For any questions or inquiries, please contact [Diwakar Singh]([email protected]).