Roda Belem Service

About   |   Features   |   Technologies   |   Requirements   |   Starting   |   License   |   Author

🎯 About

The backend service for the Roda Belém app has a hexagonal architecture with a REST API and consumes the Google Places API. It is designed for high-performance communication with the Roda Belém frontend. The frontend code of the app is here

✨ Features

✔️ Hexagonal Architecture
✔️ Scalable and easy maintenance
✔️ Cuckoo filter implemented to reduce latency and improve server response
✔️ Jwt authentication
✔️ Data persistence in MySQL database
✔️ No ORM approach, with SQLC, for faster database interaction

🚀 Technologies

The following tools were used in this project:

• Go
• Chi
• sqlc
• viper
• jwt
• Google Maps Services
• Docker
• Docker Compose
• MySQL

✅ Requirements

Before starting 🏁, you need to have Docker (with composer) and some database manager or MySQL managers (like MySQL Workbench) installed.

Create a .env file based on .env.example, you can configure the database environment variables. Remember to add your own APIs keys. Open the database and create tables according to the sql in schemas folder.

🏁 Runing up the service

# Clone this project
$ git clone https://github.com/FirerPlayer/roda-belem-service

# Access
$ cd roda-belem-service

# Run containers
$ docker compose up -d

📝 License

This project is under license from MIT. For more details, see the LICENSE file.

Made with ❤️ by Micael

 

Back to top