🏠 Project that simulates a digital real estate 🏠

• About the project
• Technologies
• Functionalities
• How to run
• Author
• License

API made with NodeJS and MongoDB stack that simulates an example of a digital real estate, where owners can share the offers of their properties. The project uses Typescript, TDD, Clean Architecture, Design Patterns and SOLID principles.

Swagger documentation can be accessed via the link.

• NodeJS
• TypeScript
• Express
• MongoDB
• MongoDB NodeJS Driver
• Bcrypt
• Validator
• Jsonwebtoken
• CEP Promise
• CPF CNPJ Validator
• Swagger UI Express
• Jest
• ESLint
• Husky
• Lint Staged
• Git Commit Msg Linter
• SuperTest

• Register Owner
• Owner Login

• Add Property
• Load Owner Properties
• Load Owner Property By Id
• Update Owner Property
• Remove Owner Property
• Load Properties
• Load Property By Id

Before starting, you will need to have the following tools installed on your machine: Git and Node.js. To work with the code, it is recommended to use a good editor, such as the VSCode.

About the database: there are some options on how to configure, such as installing MongoDB on your machine or using MongoDB Atlas, just remembering to change the database connection url in the env file.

# Clone this repository
$ git clone https://github.com/emanuelmassafera/imobiliaria-digital-api.git

# Access the project folder via the terminal/cmd
$ cd imobiliaria-digital-api

# Install dependencies
$ npm install

# Run
$ npm start

# The server will start at port:5050

This repository is licensed by MIT LICENSE. For detailed information, read the file LICENSE.

Made with ♥ by Emanuel Massafera 👋 Get in touch!