This project is an implementation of a sample application that demonstrates the use of TypeScript and Clean Architecture principles. The goal of this project is to provide an example of how to structure and build a robust and scalable application using these technologies.
☑ TypeScript
☑ Jest
☐ Express.js or Nest.js
☐ PostgreSQL
☑ Create Entitys
☑ Create UseCases
☐ Create notification partner
☐ Create database repositories
☐ API Calls using Express.js or Nest.js (to define)
To get started with this project, follow these steps:
- Clone the repository:
git clone https://github.com/diogofelizardo/typescript-clean-architecture-interview.git - Navigate to the project directory:
cd typescript-clean-architecture-interview - Install dependencies:
npm i
To run the application in development mode, use the following command: npm run start:dev
This will start the server and restart it automatically whenever changes are made to the code.
To run the application in production mode, use the following command: npm run start
To run the tests, use the following command: npm run test
This will run all the tests in the project.
If you would like to contribute to this project, please follow these steps:
- Fork the repository
- Create a new branch:
git checkout -b my-new-feature - Make your changes and commit them:
git commit -m 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request
This project is licensed under the MIT License - see the LICENSE file for details.