Bennev/hubtest-api

Clean/Hexagonal Architecture

This is a back-end project for managing users, companies and locations. In this application, a user can own multiple companies and each company can own multiple locations.

Summary

• Requirements You Need To Know
• Getting Started
• Documentation
• References
  • Articles
  • Videos
  • Repositories
• Author

Requirements You Need To Know

• Node
• NestJS
• Postgres
• TypeOrm

Getting Started

To install and run this project locally, follow the steps below:

• Clone the repository to your machine
• Access the folder with your source code editor
• Install dependencies using the command: npm install
• Create a Postgres database for this application, you can use the project's docker compose if you want
• Configure the environment variables according to the .env.example file
• Run the migrations using the command: npm run migration:run
• (Optional) You can run the tests using the command: npm run test
• Finally, start the project using the command: npm run start:dev

Documentation

If you want, the documentation will be available via the route: /doc

References

Articles

• Hexagonal architecture

• Ports-And-Adapters / Hexagonal Architecture

• Ports And Adapters Architecture

• Ports and Adapters Pattern

Videos

• 45 - Clean Architecture

• 112 - Clean Architecture com TypeScript & Node.js | ✨ API COMPLETA ✨

• Arquitetura Hexagonal na prática. feat. Rodrigo Branas

• Arquitetura Hexagonal com Nest.js

• Clean Architecture com Nest.js na prática

• Entenda CLEAN ARCHITECTURE de uma vez por todas! 🧻 | Como DEV ser!

Repositories

• domain-driven-hexagon

• clean-architecture-api-boilerplate

Author

Matheus Benevides Militão

Contacts: