Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andrescosta/todo-spring-react
An educational TODO application with a full-stack setup featuring React for the frontend, Java 21 and Spring Boot for the backend, Kubernetes for orchestration, PostgreSQL as the database, the Grafana observability stack, and KeyCloak for authentication and authorization.
https://github.com/andrescosta/todo-spring-react
docker grafana grafana-loki grafana-prometheus grafana-tempo java keycloak kubernetes openid-connect postgresql react spring spring-boot spring-rest-docs testcontainers
Last synced: 7 days ago
JSON representation
An educational TODO application with a full-stack setup featuring React for the frontend, Java 21 and Spring Boot for the backend, Kubernetes for orchestration, PostgreSQL as the database, the Grafana observability stack, and KeyCloak for authentication and authorization.
- Host: GitHub
- URL: https://github.com/andrescosta/todo-spring-react
- Owner: andrescosta
- Created: 2023-03-10T20:43:00.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-07T15:41:43.000Z (8 months ago)
- Last Synced: 2024-10-10T11:24:34.103Z (27 days ago)
- Topics: docker, grafana, grafana-loki, grafana-prometheus, grafana-tempo, java, keycloak, kubernetes, openid-connect, postgresql, react, spring, spring-boot, spring-rest-docs, testcontainers
- Language: Java
- Homepage:
- Size: 1.97 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
# Project: TODO App
## High level architecture
## Data Model
```mermaid
erDiagram
MUser ||--o{ Activity : creates
Activity ||--o{ Media : associates
Activity ||--o{ Label_Activity : associates
MUser ||--o{ Label: owns
Label ||--o{ Label_Activity : associates
MUser {
bigint id PK
uuid public_id UK
text full_name
text mail
timestamptz created_at
timestamptz updated_at
}
Activity {
bigint id PK
uuid public_id UK
text name
text description
text type
text status
text state
text[] tags
jsonb extra_data
bigint muser_id FK
timestamptz created_at
timestamptz updated_at
}
Label {
bigint id PK
uuid public_id UK
text name
text description
bigint muser_id FK
timestamptz created_at
timestamptz updated_at
}
Media {
bigint id PK
uuid public_id UK
bigint activity_id FK
text name
text type
text uri
text description
json extra_data
timestamptz created_at
timestamptz updated_at
}
Label_Activity {
bigint id PK
bigint label_id FK
bigint activity_id FK
timestamptz created_at
timestamptz updated_at
}
```
## Stack
### Activity Service
* Java 19
* Go (Improver job service)
* Spring Boot
* Spring RestDocs
* Micrometer
* Zipkin
* Loki4j
* Pyroscope
* Slf4j
* Maven
* GSon
* JJWT
### Identity Management
* KeyCloak (SSO)
* OpenID Connect
### Database
* Postgress
### API Documentation
* Asciidoctor
### Infra
* Nginx
* Docker
### Testing
* Junit 5 (Unit)
* TestContainers (Integration)
* Gatling (Performance)
### Observability
> (metrics, logs, traces, continuous profiling)
* Prometheus
* Grafana
* Loki
* Tempo
* Pyroscope
* Postgres-exporter
### Web Client
* React
* W3.CSS
* Babel
* Webpack
* Axios
## Deployment
### Requirements
- Kubernetes
- Skaffold
### Steps
* Building
``` bash
cd manifests
skaffold build
```
* Starting the enviroment
``` bash
cd manifests
skaffold run
```
* Runing integration tests
``` bash
cd test
.\mvnw surefire:test
```
* Runing performance tests
``` bash
cd .\performance\gatling\
.\mvnw gatling:test
```
* Generating the API Documentation
``` bash
cd .\todo-svc
.\mvnw package
```
## Local environment information
* Home: http://localhost:3000/
* User: test/123
* Grafana: http://localhost:3030/
* User: admin/admin
* Dashboards:
* JVM (Micrometer)
* Logs, Traces, Metrics
* PostgreSQL Database
* Keycloak: http://localhost:8282/admin/
* User: admin/admin
* PosgresSQL: localhost:5432
* Database: todo
* API Docs
* todo-svc\target\generated-docs\api-guide.html