https://github.com/deep-69bits/nest-test
https://github.com/deep-69bits/nest-test
Last synced: about 22 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/deep-69bits/nest-test
- Owner: deep-69bits
- License: mit
- Created: 2023-07-09T16:59:25.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-09T17:02:22.000Z (almost 3 years ago)
- Last Synced: 2025-03-15T15:43:56.037Z (over 1 year ago)
- Language: TypeScript
- Size: 85.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NestJs Crud CRUD API 🚀
[](https://github.com/Armanidrisi/nestjs-rest-api/blob/master/LICENSE)
[](https://github.com/Armanidrisi/nestjs-rest-api/issues)
[](https://github.com/Armanidrisi/nestjs-rest-api/stargazers)
> A simple and straightforward CRUD API built with NestJS framework. 🌟
## Features ✨
- 🌐 Basic CRUD operations (Create, Read, Update, Delete).
- ⚙️ Modular and scalable architecture using NestJS modules.
- 🛠️ Built-in validation and error handling.
- 📦 Ready-to-use configuration for database connectivity.
- 🔄 Logging and request/response interception for debugging.
- 🧪 Unit tests with Jest for ensuring code quality.
## Installation 🛠️
Ensure you have [Node.js](https://nodejs.org) and [npm](https://www.npmjs.com/) installed on your system. Then, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/Armanidrisi/nestjs-rest-api.git
```
2. Navigate to the project directory:
```bash
cd nestjs-rest-api
```
3. Install the dependencies:
```bash
npm install
```
4. Set up the configuration file:
```bash
cp .env.example .env
```
5. Customize the `.env` file with your configuration settings.
## Usage 🚀
To start the development server, run the following command:
```bash
npm run start:dev
```
Visit [http://localhost:3000](http://localhost:3000) to access the API.
## API Endpoints 🛣️
The API exposes the following endpoints:
- `GET /items`: Get all items.
- `GET /items/:id`: Get a specific item by ID.
- `POST /items`: Create a new item.
- `PUT /items/:id`: Update an existing item.
- `DELETE /items/:id`: Delete an item.
## Testing 🧪
To run the unit tests, execute the following command:
```bash
npm run test
```
## 🚀 Frameworks/Technologies Used
- NestJS: Framework for building scalable and maintainable server-side applications.
- PostgreSQL: Relational database management system.
## Contributing 🤝
Contributions are welcome! Please follow these steps to contribute:
1. Fork the repository.
2. Create a new branch.
3. Make your changes.
4. Commit and push your code.
5. Submit a pull request.
## License 📝
This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).
## Issues 🐛
If you encounter any issues or have suggestions, please [open an issue](https://github.com/Armanidrisi/nestjs-rest-api/issues).
## Stay in Touch 👋
- Author: Arman Idrisi
- Follow: [GitHub](https://github.com/Armanidrisi/)
Feel free to reach out if you have any questions or feedback!
---
Enjoy using the Simple CRUD API! If you find it helpful, please give it a ⭐️ to show your support.