ts-clean-api
ts-clean-api copied to clipboard
RESTful API using Typescript, TDD, Clean Architecture, Design Patterns, SOLID principles and Prisma
ts-clean-api
This repository contains a clean and organized API built with TypeScript and Node.js. The API follows the principles of clean architecture and uses the latest best practices for building scalable and maintainable web applications.
Features
- Written in TypeScript for type safety and better developer experience
- Uses the Express web framework for building the API
- Utilizes the repository pattern for data access and separates the business logic from the infrastructure
- Implements a testing strategy with unit and integration tests
- Follows the principles of clean architecture and SOLID design principles
- Uses a linter to enforce code style consistency
Prerequisites
- Node.js and npm (or yarn)
- A code editor of your choice
Tests
To run the tests, use the following command:
npm run test
(or yarn test
)
Linting
To lint the code, use the following command:
npm run lint
(or yarn lint
)
Built With
- TypeScript - A typed superset of JavaScript that compiles to plain JavaScript
- Node.js - A JavaScript runtime built on Chrome's V8 JavaScript engine
- Express - A fast, minimalist web framework for Node.js
Contributing
We welcome contributions to this repository. If you have an idea for a new feature or have found a bug, please open an issue to discuss it. If you want to contribute code, please fork the repository and create a pull request with your changes.
License
This project is licensed under the MIT License - see the LICENSE file for details.