Skip to content

Latest commit

 

History

History
112 lines (72 loc) · 2.99 KB

README.md

File metadata and controls

112 lines (72 loc) · 2.99 KB
Raw

Nest Logo

NestJs Crud CRUD API 🚀

GitHub license GitHub issues GitHub stars

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 and npm installed on your system. Then, follow these steps:

  1. Clone the repository:
git clone https://github.com/Armanidrisi/nestjs-rest-api.git
  1. Navigate to the project directory:
cd nestjs-rest-api
  1. Install the dependencies:
npm install
  1. Set up the configuration file:
cp .env.example .env
  1. Customize the .env file with your configuration settings.

Usage 🚀

To start the development server, run the following command:

npm run start:dev

Visit 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:

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.

Issues 🐛

If you encounter any issues or have suggestions, please open an issue.

Stay in Touch 👋

  • Author: Arman Idrisi
  • Follow: GitHub

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.