Meetings is an application developed by Group-3
during the course
Advanced Technologies in Software Construction, as was taught during first semester of 2023.
Available on docs
Name | File | |
---|---|---|
Alvarez, Leandro | 146.887-0 | lean.alvarez@live.com.ar |
Sanchez, Tomas | 166.043-3 | tosacnehz@frba.utn.edu.ar |
Yogui Arakaki, Matias Ezequiel | 167.264-2 | myogui@frba.utn.edu.ar |
This project uses GitHub Actions
.
Read more about in the documentation site
It is recommended to use IntelliJ.
- Clone the repository
Via HTTPS
git clone https://github.com/tomasanchez/grupo-3-tacs.git
or SSH
git clone git@github.com:tomasanchez/grupo-3-tacs.git
- Install Docker
Read the official website about Docker
For more information about technologies used, how to set up development environment, running local,
read the README
file on auth
module, for the scheduler service, README
file on scheduler
, and README
file on api-gateway
package.
We are using OpenAPI
to document our API. You will find all available endpoints, request and
response bodies, along with the status codes that they produce in there.
See README
file on web
package.
-
Install Loki Docker Driver
docker plugin install grafana/loki-docker-driver:latest --alias loki --grant-all-permissions
-
Build application image and start all services with docker-compose
docker-compose build docker-compose up -d
-
Open the Meetings Web Service http://localhost:5173 in your browser.
-
Test the api from API Gateway Swagger UI http://localhost/docs.
-
Check predefined dashboard
FastAPI Observability
on Grafana http://localhost:3000/
A customer should be able to schedule events, creating, or joining them. Administrators should be able to see different statistics about the events.
At a high level, we should have different systems, with single responsibilities. One system should be responsible for managing the workflows of the events, another schedules events, and the last one for validating users' credentials.
We are planning to have a microservices' architecture. We take into account:
- Scalability
- Each service can be scaled independently, allowing for better resource utilization and more efficient scaling.
- Resilience:
- If a single component fails, the rest of the application can still function.
- Technology diversity:
- Each service can be developed using a different technology stack, allowing for better specialization and more efficient development.
- Deployment:
- Each service can be deployed independently, allowing for more efficient deployment and better resource utilization, as well as faster rollback in case of failure, easier to deploy new features.
Overall, a microservices architecture provides more flexibility, scalability, and resilience than a monolithic architecture. While it may require more initial setup and development, it can ultimately make the application easier to maintain and more efficient.
Users will be able to interact with the application through the Web
module. This module will be responsible for
interacting with the API Gateway
module, which will be responsible for routing the requests to the corresponding
service. However, this is not the only interface, there is a Bot
service which allows user interaction via Telegram.
The main idea is to have an API Gateway
that will serve as an entry point for the communication between the
microservices. It will be responsible for routing the requests to the corresponding service, making the corresponding
validations.
One of these validations will be to limit the number of requests that a user can make in a given time. This will be
done using a Rate Limiter
as a middleware. For that purpose, we will use Redis
, It can be interchanged
with a Redis Cluster
so that we can have a distributed cache, in case more than one instance of the API Gateway
is
running.
Auth
module will be responsible for validating users.
SchedulerApplication
module will be responsible for managing the workflows of the events.
Observe the FastAPI application with three pillars of observability on Grafana:
- Traces with Tempo and OpenTelemetry Python SDK
- Metrics with Prometheus and Prometheus Python Client
- Logs with Loki
All material is provided under an MIT License unless otherwise specified.
MIT License: https://mit-license.org/ or see the LICENSE
file.