This is a sample API for Real Estate Companies, capable of cataloging properties (for sale and rental), their categories and features, manage their users (customers and realtors), and much more.
The documentation and all test routes can be found here: Real Estate API docs (deployed in a AWS EC2 t2.micro with CI/CD provided by GitHub actions)
This RESTful API was built using this tecnologies:
- Core: NodeJS with ExpressJS framework
- Language: TypeScript with JavaScript when required
- Database: PostgreSQL with PrismaORM
- Testing: Jest for unit testing Supertest for integration
- Documentation: Swagger with Open API 3
- Containerization: Docker
- Storage: Cloudinary or AWS S3
- Dates: DayJS
- Email: Ethereal
- Security: Rate Limiter Flexible with Redis
- Standardization: ESLint and Prettier
I tried to follow most SOLID principles, apply TDD and DDD, while keeping OOP best practices. Most implementations follow a interface to facilitate exchange of providers.
#TODO
- Fix some of the routes
- Testing should cover at least 90% of use cases
- Improve and extend documentation
- Add different implementations for date and email
- Add domain and SSL