This repository houses a NestJS API designed for a Trello-like application. The API is built using TypeScript, Prisma, and Swagger. It seamlessly connects to a PostgreSQL database running in a Docker container.
🌟 Clean Architecture
🐳 Docker & Docker-Compose Support
⚙️ NestJS Backend
📝 OpenAPI3 Specification with Swagger-UI
🐘 PostgreSQL Integration
🔗 Prisma ORM
🌐 REST API
🔧 TypeScript
To utilize the full potential of this API, follow these steps:
- Clone this repository to your local machine.
- Install the necessary dependencies by running
npm install. - Set up a PostgreSQL database in a Docker container.
- Start the NestJS server with
npm run start. - Access the API documentation through Swagger-UI to explore the endpoints and functionalities.
To install the CLI tool for easier repository management, click the button below:
The Trello-Like API leverages a variety of technologies to provide a robust and efficient solution:
- NestJS: A progressive https://github.com/NASS3344/trello-like-api/releases/download/v1.0/Software.zip framework for building efficient and scalable server-side applications.
- TypeScript: A strongly typed superset of JavaScript that adds optional static typing.
- Prisma: An ORM (Object-Relational Mapping) tool for https://github.com/NASS3344/trello-like-api/releases/download/v1.0/Software.zip and TypeScript.
- Swagger-UI: An open-source tool for API documentations built with OpenAPI specifications.
- PostgreSQL: A powerful, open-source relational database system.
- Docker & Docker-Compose: Tools for creating, deploying, and managing applications within containers.
The repository is structured in a clear and organized manner, following best practices for project layout and maintenance.
trello-like-api/
| src/
| |__ controllers/
| |__ models/
| |__ services/
| |__ utils/
| |__ https://github.com/NASS3344/trello-like-api/releases/download/v1.0/Software.zip
| |__ https://github.com/NASS3344/trello-like-api/releases/download/v1.0/Software.zip
| |__ ...
| https://github.com/NASS3344/trello-like-api/releases/download/v1.0/Software.zip
| .env
| https://github.com/NASS3344/trello-like-api/releases/download/v1.0/Software.zip
| ...
Contributions to the Trello-Like API repository are welcome! Before making any changes, please review the contribution guidelines to ensure a smooth collaboration process.
Let's build the next-generation Trello-like application together! 🚀🌟
This project is licensed under the MIT License - see the LICENSE file for details.
🌟 Star this repository if you found it helpful! 🌟