• If you want to run the api container, you have to install Docker in your OS.
• If you want to run it locally, you need to install node v20.9.

• To run in the container option, you can execute the following instruction in your terminal docker compose up.

• Run npm install.
• Production mode: you have to run npm run build, npm run start:prod;
• Development mode: you can run npm run start or even npm run start:dev;

To use Swagger you can access the address http://localhost:3000/api in your browser after running the application.

To run the tests you have to npm install all packages.

• If you want to run only unit tests you can run npm run test:unit:noWatch;
• If you want to run only integration tests you can run npm run test:integration:noWatch;
• If you want to run only e2e tests you can run npm run test:e2e:noWatch;
• If you want to run all of them you can run npm run test.

• I decided to use Screaming Architecture in the project to make it looks like a Pro/Project application and not only another project that has the same layers and everything similar. Also, it makes the project more understandable.
• I also followed some good practices like TDD, SOLID, Clean Code.
• I decided to use a json file instead a database to store/search the projects to not add more complexity. But with the made project responsability divisions, it would be simple:
  • Choose and create a database;
  • Necessary to install the dependencies;
  • Code a new repository to it;
  • The rest of the code would stay the same and working as well.
• Swagger was added to documentate the code and make the manual testing process simpler.
• Conventional commits and small commits were used during the whole development cycle to make the commits more understandable.
• A strict Typescript was used, to force you to define types to in code.

This project is a Pro-Project matcher. It aims to verify for which project the Pro is most qualified for. With that, we can automate the proccess of deliverying projects to the pros and save a lot of time.

This project follows Screaming Architecture to make it more understandable and simpler to maintenance. It was built with Typescript language and NestJS framework.

If you have any questions or feedback, you can reach me at [email protected] or via my GitHub profile @kistgab.