mirror of
https://github.com/dat515-2025/Group-8.git
synced 2026-03-22 06:57:47 +01:00
Compare commits
23 Commits
51-refacto
...
515106b238
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
515106b238 | ||
|
|
b5290119e9 | ||
| 0beb889f5e | |||
|
|
0a96c32c93 | ||
|
|
f1034f6ed5 | ||
| 0f729d28d1 | |||
| c689caea88 | |||
| 8c20deb690 | |||
| 39979b51ee | |||
| da0c77101d | |||
| a5a83e5d07 | |||
| 3749aa4525 | |||
| 94aa64addc | |||
| ba1677b2d3 | |||
|
|
8ea1ef9eea | ||
|
|
4b614902b2 | ||
| a152ecbe4d | |||
| 7d7dd98d0f | |||
| 5aca071ac2 | |||
|
|
80991c7390 | ||
|
|
1403e0029b | ||
| aa63e51e6a | |||
|
|
4aaaba3956 |
2
.github/workflows/build-image.yaml
vendored
2
.github/workflows/build-image.yaml
vendored
@@ -94,7 +94,7 @@ jobs:
|
|||||||
tags: |
|
tags: |
|
||||||
${{ env.IMAGE_REPO }}:${{ env.TAG1 }}
|
${{ env.IMAGE_REPO }}:${{ env.TAG1 }}
|
||||||
${{ env.IMAGE_REPO }}:${{ env.TAG2 }}
|
${{ env.IMAGE_REPO }}:${{ env.TAG2 }}
|
||||||
platforms: linux/amd64
|
platforms: linux/arm64,linux/amd64
|
||||||
|
|
||||||
- name: Set outputs
|
- name: Set outputs
|
||||||
id: set
|
id: set
|
||||||
|
|||||||
@@ -1,43 +1,6 @@
|
|||||||
# Lab 6: Design Document for Course Project
|
# Personal Finance Tracker
|
||||||
|
## Folder Structure
|
||||||
| Lab 6: | Design Document for Course Project |
|
- meetings: Contains note from meetings
|
||||||
| ----------- | ---------------------------------- |
|
- scr: Source code for the project
|
||||||
| Subject: | DAT515 Cloud Computing |
|
- checklist: Project checklist and self assessment tracking
|
||||||
| Deadline: | **September 19, 2025 23:59** |
|
- report.md: Detailed report of the project
|
||||||
| Grading: | No Grade |
|
|
||||||
| Submission: | Group |
|
|
||||||
|
|
||||||
## Table of Contents
|
|
||||||
|
|
||||||
- [Table of Contents](#table-of-contents)
|
|
||||||
- [1. Design Document (design.md)](#1-design-document-designmd)
|
|
||||||
|
|
||||||
The design document is the first deliverable for your project.
|
|
||||||
We separated this out as a separate deliverable, with its own deadline, to ensure that you have a clear plan before you start coding.
|
|
||||||
This part only needs a cursory review by the teaching staff to ensure it is sufficiently comprehensive, while still realistic.
|
|
||||||
The teaching staff will assign you to a project mentor who will provide guidance and support throughout the development process.
|
|
||||||
|
|
||||||
## 1. Design Document (design.md)
|
|
||||||
|
|
||||||
You are required to prepare a design document for your application.
|
|
||||||
The design doc should be brief, well-organized and easy to understand.
|
|
||||||
The design doc should be prepared in markdown format and named `design.md` and submitted in the project group's repository.
|
|
||||||
Remember that you can use [mermaid diagrams](https://github.com/mermaid-js/mermaid#readme) in markdown files.
|
|
||||||
|
|
||||||
The design doc **should include** the following sections:
|
|
||||||
|
|
||||||
- **Overview**: A brief description of the application and its purpose.
|
|
||||||
- **Architecture**: The high-level architecture of the application, including components, interactions, and data flow.
|
|
||||||
- **Technologies**: The cloud computing technologies or services used in the application.
|
|
||||||
- **Deployment**: The deployment strategy for the application, including any infrastructure requirements.
|
|
||||||
|
|
||||||
The design document should be updated throughout the development process and reflect the final implementation of your project.
|
|
||||||
|
|
||||||
Optional sections may include:
|
|
||||||
|
|
||||||
- Security: The security measures implemented in the application to protect data and resources.
|
|
||||||
- Scalability: The scalability considerations for the application, including load balancing and auto-scaling.
|
|
||||||
- Monitoring: The monitoring and logging strategy for the application to track performance and detect issues.
|
|
||||||
- Disaster Recovery: The disaster recovery plan for the application to ensure business continuity in case of failures.
|
|
||||||
- Cost Analysis: The cost analysis of running the application on the cloud, including pricing models and cost-saving strategies.
|
|
||||||
- References: Any external sources or references used in the design document.
|
|
||||||
@@ -7,64 +7,64 @@ Focus on areas that align with your project goals and interests.
|
|||||||
The core deliverables are required.
|
The core deliverables are required.
|
||||||
This means that you must get at least 2 points for each item in this category.
|
This means that you must get at least 2 points for each item in this category.
|
||||||
|
|
||||||
| **Category** | **Item** | **Max Points** | **Points** |
|
| **Category** | **Item** | **Max Points** | **Points** | **Comments** |
|
||||||
|----------------------------------| --------------------------------------- | -------------- |-------------------------------------------------|
|
|----------------------------------| --------------------------------------- | -------------- |-------------------------------------------------|---------------|
|
||||||
| **Core Deliverables (Required)** | | | |
|
| **Core Deliverables (Required)** | | | | |
|
||||||
| Codebase & Organization | Well-organized project structure | 5 | 5 |
|
| Codebase & Organization | Well-organized project structure | 5 | 5 | |
|
||||||
| | Clean, readable code | 5 | 4 |
|
| | Clean, readable code | 5 | 4 | |
|
||||||
| | Use planning tool (e.g., GitHub issues) | 5 | 4 |
|
| | Use planning tool (e.g., GitHub issues) | 5 | 4 | |
|
||||||
| | Proper version control usage | 5 | 5 |
|
| | Proper version control usage | 5 | 5 | |
|
||||||
| 23 | Complete source code | 5 | 5 |
|
| 23 | Complete source code | 5 | 5 | |
|
||||||
| Documentation | Comprehensive reproducibility report | 10 | 4-5 |
|
| Documentation | Comprehensive reproducibility report | 10 | 4-5 | |
|
||||||
| | Updated design document | 5 | 2 |
|
| | Updated design document | 5 | 2 | |
|
||||||
| | Clear build/deployment instructions | 5 | 2 |
|
| | Clear build/deployment instructions | 5 | 2 | |
|
||||||
| | Troubleshooting guide | 5 | 1 |
|
| | Troubleshooting guide | 5 | 1 | |
|
||||||
| | Completed self-assessment table | 5 | 2 |
|
| | Completed self-assessment table | 5 | 2 | |
|
||||||
| 14 | Hour sheets for all members | 5 | 3 |
|
| 14 | Hour sheets for all members | 5 | 3 | |
|
||||||
| Presentation Video | Project demonstration | 5 | 0 |
|
| Presentation Video | Project demonstration | 5 | 0 | |
|
||||||
| | Code walk-through | 5 | 0 |
|
| | Code walk-through | 5 | 0 | |
|
||||||
| 0 | Deployment showcase | 5 | 0 |
|
| 0 | Deployment showcase | 5 | 0 | |
|
||||||
| **Technical Implementation** | | | |
|
| **Technical Implementation** | | | | |
|
||||||
| Application Functionality | Basic functionality works | 10 | 8 |
|
| Application Functionality | Basic functionality works | 10 | 8 | |
|
||||||
| | Advanced features implemented | 10 | 0 |
|
| | Advanced features implemented | 10 | 0 | |
|
||||||
| | Error handling & robustness | 10 | 4 |
|
| | Error handling & robustness | 10 | 4 | |
|
||||||
| 16 | User-friendly interface | 5 | 4 |
|
| 16 | User-friendly interface | 5 | 4 | |
|
||||||
| Backend & Architecture | Stateless web server | 5 | 5 |
|
| Backend & Architecture | Stateless web server | 5 | 5 | |
|
||||||
| | Stateful application | 10 | ? WHAT DOES THIS MEAN |
|
| | Stateful application | 10 | ? WHAT DOES THIS MEAN | |
|
||||||
| | Database integration | 10 | 10 |
|
| | Database integration | 10 | 10 | |
|
||||||
| | API design | 5 | 5 |
|
| | API design | 5 | 5 | |
|
||||||
| 20 | Microservices architecture | 10 | 0 |
|
| 20 | Microservices architecture | 10 | 0 | |
|
||||||
| Cloud Integration | Basic cloud deployment | 10 | 10 |
|
| Cloud Integration | Basic cloud deployment | 10 | 10 | |
|
||||||
| | Cloud APIs usage | 10 | ? WHAT DOES THIS MEAN |
|
| | Cloud APIs usage | 10 | ? WHAT DOES THIS MEAN | |
|
||||||
| | Serverless components | 10 | 0 |
|
| | Serverless components | 10 | 0 | |
|
||||||
| 10 | Advanced cloud services | 5 | 0 |
|
| 10 | Advanced cloud services | 5 | 0 | |
|
||||||
| **DevOps & Deployment** | | | |
|
| **DevOps & Deployment** | | | | |
|
||||||
| Containerization | Basic Dockerfile | 5 | 5 |
|
| Containerization | Basic Dockerfile | 5 | 5 | |
|
||||||
| | Optimized Dockerfile | 5 | 0 |
|
| | Optimized Dockerfile | 5 | 0 | |
|
||||||
| | Docker Compose | 5 | 5 - dev only |
|
| | Docker Compose | 5 | 5 - dev only | |
|
||||||
| 15 | Persistent storage | 5 | 5 |
|
| 15 | Persistent storage | 5 | 5 | |
|
||||||
| Deployment & Scaling | Manual deployment | 5 | 5 |
|
| Deployment & Scaling | Manual deployment | 5 | 5 | |
|
||||||
| | Automated deployment | 5 | 5 |
|
| | Automated deployment | 5 | 5 | |
|
||||||
| | Multiple replicas | 5 | 5 |
|
| | Multiple replicas | 5 | 5 | |
|
||||||
| 20 | Kubernetes deployment | 10 | 10 |
|
| 20 | Kubernetes deployment | 10 | 10 | |
|
||||||
| **Quality Assurance** | | | |
|
| **Quality Assurance** | | | | |
|
||||||
| Testing | Unit tests | 5 | 2 |
|
| Testing | Unit tests | 5 | 2 | |
|
||||||
| | Integration tests | 5 | 2 |
|
| | Integration tests | 5 | 2 | |
|
||||||
| | End-to-end tests | 5 | 5 |
|
| | End-to-end tests | 5 | 5 | |
|
||||||
| 9 | Performance testing | 5 | 0 |
|
| 9 | Performance testing | 5 | 0 | |
|
||||||
| Monitoring & Operations | Health checks | 5 | 5 |
|
| Monitoring & Operations | Health checks | 5 | 5 | |
|
||||||
| | Logging | 5 | 2 - only to terminal add logstash |
|
| | Logging | 5 | 2 - only to terminal add logstash | |
|
||||||
| 9 | Metrics/Monitoring | 5 | 2 - only DB, need to create Prometheus endpoint |
|
| 9 | Metrics/Monitoring | 5 | 2 - only DB, need to create Prometheus endpoint | |
|
||||||
| Security | HTTPS/TLS | 5 | 5 |
|
| Security | HTTPS/TLS | 5 | 5 | |
|
||||||
| | Authentication | 5 | 5 |
|
| | Authentication | 5 | 5 | |
|
||||||
| 15 | Authorization | 5 | 5 |
|
| 15 | Authorization | 5 | 5 | |
|
||||||
| **Innovation & Excellence** | | | |
|
| **Innovation & Excellence** | | | | |
|
||||||
| Advanced Features and | AI/ML Integration | 10 | 0 |
|
| Advanced Features and | AI/ML Integration | 10 | 0 | |
|
||||||
| Technical Excellence | Real-time features | 10 | 0 |
|
| Technical Excellence | Real-time features | 10 | 0 | |
|
||||||
| | Creative problem solving | 10 | ? |
|
| | Creative problem solving | 10 | ? | |
|
||||||
| | Performance optimization | 5 | 2 |
|
| | Performance optimization | 5 | 2 | |
|
||||||
| 2 | Exceptional user experience | 5 | 0 |
|
| 2 | Exceptional user experience | 5 | 0 | |
|
||||||
| **Total** | | **255** | **153** |
|
| **Total** | | **255** | **153** | |
|
||||||
|
|
||||||
## Grading Scale
|
## Grading Scale
|
||||||
|
|
||||||
|
|||||||
@@ -9,6 +9,8 @@
|
|||||||
|
|
||||||
**Project Name**: Personal Finance Tracker
|
**Project Name**: Personal Finance Tracker
|
||||||
|
|
||||||
|
**Deployment URL**: https://finance.ltrk.cz/
|
||||||
|
|
||||||
**Group Members**:
|
**Group Members**:
|
||||||
|
|
||||||
- 289229, Lukáš Trkan, lukastrkan
|
- 289229, Lukáš Trkan, lukastrkan
|
||||||
@@ -45,7 +47,6 @@ flowchart TB
|
|||||||
svc <-- HTTP request/response --> api[("UniRate API")]
|
svc <-- HTTP request/response --> api[("UniRate API")]
|
||||||
client <-- HTTP request/response --> n2
|
client <-- HTTP request/response --> n2
|
||||||
```
|
```
|
||||||
|
|
||||||
The workflow works in the following way:
|
The workflow works in the following way:
|
||||||
|
|
||||||
- Client connects to the frontend. After login, frontend automatically fetches the stored transactions from
|
- Client connects to the frontend. After login, frontend automatically fetches the stored transactions from
|
||||||
@@ -54,6 +55,60 @@ The workflow works in the following way:
|
|||||||
using background worker.
|
using background worker.
|
||||||
- After successful load, these transactions are stored to the database and displayed to the client
|
- After successful load, these transactions are stored to the database and displayed to the client
|
||||||
|
|
||||||
|
### Database Schema
|
||||||
|
|
||||||
|
```mermaid
|
||||||
|
classDiagram
|
||||||
|
direction BT
|
||||||
|
class alembic_version {
|
||||||
|
varchar(32) version_num
|
||||||
|
}
|
||||||
|
class categories {
|
||||||
|
varchar(100) name
|
||||||
|
varchar(255) description
|
||||||
|
char(36) user_id
|
||||||
|
int(11) id
|
||||||
|
}
|
||||||
|
class category_transaction {
|
||||||
|
int(11) category_id
|
||||||
|
int(11) transaction_id
|
||||||
|
}
|
||||||
|
class oauth_account {
|
||||||
|
char(36) user_id
|
||||||
|
varchar(100) oauth_name
|
||||||
|
varchar(4096) access_token
|
||||||
|
int(11) expires_at
|
||||||
|
varchar(1024) refresh_token
|
||||||
|
varchar(320) account_id
|
||||||
|
varchar(320) account_email
|
||||||
|
char(36) id
|
||||||
|
}
|
||||||
|
class transaction {
|
||||||
|
blob amount
|
||||||
|
blob description
|
||||||
|
char(36) user_id
|
||||||
|
date date
|
||||||
|
int(11) id
|
||||||
|
}
|
||||||
|
class user {
|
||||||
|
varchar(100) first_name
|
||||||
|
varchar(100) last_name
|
||||||
|
varchar(320) email
|
||||||
|
varchar(1024) hashed_password
|
||||||
|
tinyint(1) is_active
|
||||||
|
tinyint(1) is_superuser
|
||||||
|
tinyint(1) is_verified
|
||||||
|
longtext config
|
||||||
|
char(36) id
|
||||||
|
}
|
||||||
|
|
||||||
|
categories --> user : user_id -> id
|
||||||
|
category_transaction --> categories : category_id -> id
|
||||||
|
category_transaction --> transaction : transaction_id -> id
|
||||||
|
oauth_account --> user : user_id -> id
|
||||||
|
transaction --> user : user_id -> id
|
||||||
|
```
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
|
||||||
- The stored transactions are encrypted in the DB for security reasons.
|
- The stored transactions are encrypted in the DB for security reasons.
|
||||||
@@ -77,6 +132,14 @@ The workflow works in the following way:
|
|||||||
etc.).
|
etc.).
|
||||||
- Deployment Chart (charts/myapp-chart/): Helm chart to deploy the application to Kubernetes.
|
- Deployment Chart (charts/myapp-chart/): Helm chart to deploy the application to Kubernetes.
|
||||||
|
|
||||||
|
### Other services deployed in the cluster
|
||||||
|
|
||||||
|
- Longhorn: distributed storage system providing persistent volumes for the database and other services
|
||||||
|
- Prometheus + Grafana: monitoring stack collecting metrics from the app and cluster, visualized in Grafana dashboards
|
||||||
|
- MariaDB operator: manages the MariaDB cluster based on Custom resources, creates Databases, users, handles backups
|
||||||
|
- RabbitMQ operator: manages RabbitMQ cluster based on Custom resources
|
||||||
|
- Cloudflare Tunnel: allows public access to backend API running in the private cluster, providing HTTPS
|
||||||
|
|
||||||
### Technologies Used
|
### Technologies Used
|
||||||
|
|
||||||
- Backend: Python, FastAPI, FastAPI Users, SQLAlchemy, Pydantic, Alembic, Celery
|
- Backend: Python, FastAPI, FastAPI Users, SQLAlchemy, Pydantic, Alembic, Celery
|
||||||
@@ -89,10 +152,15 @@ The workflow works in the following way:
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
|
Here are software and hardware prerequisites for the development and production environments. This section also
|
||||||
|
describes
|
||||||
|
necessary environment variables and key dependencies used in the project.
|
||||||
|
|
||||||
### System Requirements
|
### System Requirements
|
||||||
|
|
||||||
#### Development
|
#### Development
|
||||||
|
|
||||||
|
- OS: Tested on MacOS, Linux and Windows should work as well
|
||||||
- Minimum RAM: 8 GB
|
- Minimum RAM: 8 GB
|
||||||
- Storage: 10 GB+ free
|
- Storage: 10 GB+ free
|
||||||
|
|
||||||
@@ -136,10 +204,10 @@ The workflow works in the following way:
|
|||||||
#### Backend
|
#### Backend
|
||||||
|
|
||||||
- `MOJEID_CLIENT_ID`, `MOJEID_CLIENT_SECRET` \- OAuth client ID and secret for
|
- `MOJEID_CLIENT_ID`, `MOJEID_CLIENT_SECRET` \- OAuth client ID and secret for
|
||||||
MojeID - https://www.mojeid.cz/en/provider/
|
[MojeID](https://www.mojeid.cz/en/provider/)
|
||||||
- `BANKID_CLIENT_ID`, `BANKID_CLIENT_SECRET` \- OAuth client ID and secret for BankID - https://developer.bankid.cz/
|
- `BANKID_CLIENT_ID`, `BANKID_CLIENT_SECRET` \- OAuth client ID and secret for [BankID](https://developer.bankid.cz/)
|
||||||
- `CSAS_CLIENT_ID`, `CSAS_CLIENT_SECRET` \- OAuth client ID and secret for Česká
|
- `CSAS_CLIENT_ID`, `CSAS_CLIENT_SECRET` \- OAuth client ID and secret for [Česká
|
||||||
spořitelna - https://developers.erstegroup.com/docs/apis/bank.csas
|
spořitelna](https://developers.erstegroup.com/docs/apis/bank.csas)
|
||||||
- `DATABASE_URL`(or `MARIADB_HOST`, `MARIADB_PORT`, `MARIADB_DB`, `MARIADB_USER`, `MARIADB_PASSWORD`) \- MariaDB
|
- `DATABASE_URL`(or `MARIADB_HOST`, `MARIADB_PORT`, `MARIADB_DB`, `MARIADB_USER`, `MARIADB_PASSWORD`) \- MariaDB
|
||||||
connection details
|
connection details
|
||||||
- `RABBITMQ_USERNAME`, `RABBITMQ_PASSWORD` \- credentials for RabbitMQ
|
- `RABBITMQ_USERNAME`, `RABBITMQ_PASSWORD` \- credentials for RabbitMQ
|
||||||
@@ -195,17 +263,17 @@ bash upgrade_database.sh
|
|||||||
|
|
||||||
### 5) Run backend
|
### 5) Run backend
|
||||||
|
|
||||||
|
Before running the backend, make sure to set the necessary environment variables. Either by setting them in your shell
|
||||||
|
or by setting them in run configuration in your IDE.
|
||||||
```bash
|
```bash
|
||||||
cd backend
|
cd backend
|
||||||
|
|
||||||
#TODO: set env variables
|
|
||||||
uvicorn app.app:fastApi --reload --host 0.0.0.0 --port 8000
|
uvicorn app.app:fastApi --reload --host 0.0.0.0 --port 8000
|
||||||
```
|
```
|
||||||
|
|
||||||
### 6) Run Celery worker (optional, in another terminal)
|
### 6) Run Celery worker (optional, in another terminal)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd Group-8/7project/backend
|
cd Group-8/7project/src/backend
|
||||||
source .venv/bin/activate
|
source .venv/bin/activate
|
||||||
celery -A app.celery_app.celery_app worker -l info
|
celery -A app.celery_app.celery_app worker -l info
|
||||||
```
|
```
|
||||||
@@ -225,8 +293,11 @@ npm run dev
|
|||||||
|
|
||||||
### Backend
|
### Backend
|
||||||
|
|
||||||
|
App is separated into backend and frontend so it also needs to be built separately. Backend is build into docker image
|
||||||
|
and frontend is deployed as static files.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd 7project/backend
|
cd 7project/src/backend
|
||||||
# Dont forget to set correct image tag with your registry and name
|
# Dont forget to set correct image tag with your registry and name
|
||||||
# For example lukastrkan/cc-app-demo or gitea.ltrk.dev/lukas/cc-app-demo
|
# For example lukastrkan/cc-app-demo or gitea.ltrk.dev/lukas/cc-app-demo
|
||||||
docker buildx build --platform linux/amd64,linux/arm64 -t CHANGE_ME --push .
|
docker buildx build --platform linux/amd64,linux/arm64 -t CHANGE_ME --push .
|
||||||
@@ -235,16 +306,20 @@ docker buildx build --platform linux/amd64,linux/arm64 -t CHANGE_ME --push .
|
|||||||
### Frontend
|
### Frontend
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd project7/frontend
|
cd project7/src/frontend
|
||||||
npm ci
|
npm ci
|
||||||
npm run build
|
npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
## Deployment Instructions
|
## Deployment Instructions
|
||||||
|
|
||||||
|
Deployment is tested on TalosOS cluster with 1 control plane and 4 workers, cluster needs to be setup and configured
|
||||||
|
manually. Terraform/OpenTofu is then used to deploy base services to the cluster. App itself is deployed automatically
|
||||||
|
via GitHub actions and Helm chart. Frontend files are deployed to Cloudflare pages.
|
||||||
|
|
||||||
### Setup Cluster
|
### Setup Cluster
|
||||||
|
|
||||||
Deployment should work on any Kubernetes cluster. However, we are using 4 TalosOS virtual machines (1 control plane, 3
|
Deployment should work on any Kubernetes cluster. However, we are using 5 TalosOS virtual machines (1 control plane, 4
|
||||||
workers)
|
workers)
|
||||||
running on top of Proxmox VE.
|
running on top of Proxmox VE.
|
||||||
|
|
||||||
@@ -254,7 +329,7 @@ running on top of Proxmox VE.
|
|||||||
4) Navigate to tofu directory
|
4) Navigate to tofu directory
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd 7project/tofu
|
cd 7project/src/tofu
|
||||||
````
|
````
|
||||||
|
|
||||||
5) Set IP addresses in environment variables
|
5) Set IP addresses in environment variables
|
||||||
@@ -423,16 +498,17 @@ The tests are located in 7project/backend/tests directory. All tests are run by
|
|||||||
push to main.
|
push to main.
|
||||||
See the workflow [here](../.github/workflows/run-tests.yml).
|
See the workflow [here](../.github/workflows/run-tests.yml).
|
||||||
|
|
||||||
If you want to run the tests locally, the preferred way is to use a [bash script](src/backend/test_locally.sh)
|
If you want to run the tests locally, the preferred way is to use a [bash script](backend/test_locally.sh)
|
||||||
that will start a test DB container with [docker compose](src/backend/docker-compose.test.yml) and remove it afterwards.
|
that will start a test DB container with [docker compose](backend/docker-compose.test.yml) and remove it afterwards.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cd 7project/backend
|
cd 7project/src/backend
|
||||||
bash test_locally.sh
|
bash test_locally.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
### Unit Tests
|
### Unit Tests
|
||||||
|
|
||||||
There are 5 basic unit tests, since our services logic is very simple
|
There are only 5 basic unit tests, since our services logic is very simple
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
bash test_locally.sh --only-unit
|
bash test_locally.sh --only-unit
|
||||||
@@ -484,7 +560,12 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
|
|||||||
|
|
||||||
### Frontend
|
### Frontend
|
||||||
|
|
||||||
- Start with: npm run dev in 7project/frontend
|
- Start with:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run dev in 7project/src/frontend
|
||||||
|
```
|
||||||
|
|
||||||
- Ensure VITE_BACKEND_URL is set to the backend URL (e.g., http://127.0.0.1:8000)
|
- Ensure VITE_BACKEND_URL is set to the backend URL (e.g., http://127.0.0.1:8000)
|
||||||
- Open http://localhost:5173
|
- Open http://localhost:5173
|
||||||
- Login, view latest transactions, filter, and add new transactions from the UI.
|
- Login, view latest transactions, filter, and add new transactions from the UI.
|
||||||
@@ -506,24 +587,54 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
|
|||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
|
|
||||||
### Common Issues
|
### Common Issues
|
||||||
|
|
||||||
#### Issue 1: [Common problem]
|
#### Issue 1: Unable to apply Cloudflare terraform module
|
||||||
|
|
||||||
**Symptoms**: [What the user sees]
|
**Symptoms**: Terraform/OpenTofu apply fails during Cloudflare module deployment.
|
||||||
**Solution**: [Step-by-step fix]
|
This is caused by unknown variable not known beforehand.
|
||||||
|
|
||||||
#### Issue 2: [Another common problem]
|
**Solution**: Apply first without Cloudflare module and then apply again.
|
||||||
|
|
||||||
**Symptoms**: [What the user sees]
|
```bash
|
||||||
**Solution**: [Step-by-step fix]
|
tofu apply -exclude modules.cloudflare
|
||||||
|
tofu apply
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Issue 2: Pods are unable to start
|
||||||
|
|
||||||
|
**Symptoms**: Pods are unable to start with ImagePullBackOff error. This could be caused
|
||||||
|
by either hitting docker hub rate limits or by docker hub being down.
|
||||||
|
|
||||||
|
**Solution**: Make sure you updated the cluster config to use registry mirror as described in
|
||||||
|
"Setup Cluster" section.
|
||||||
|
|
||||||
### Debug Commands
|
### Debug Commands
|
||||||
|
|
||||||
|
Get a detailed description of the Deployment:
|
||||||
```bash
|
```bash
|
||||||
# Useful commands for debugging
|
kubectl describe deployment finance-tracker -n prod
|
||||||
# Log viewing commands
|
```
|
||||||
# Service status checks
|
|
||||||
|
Get a list of pods in the Deployment:
|
||||||
|
```bash
|
||||||
|
kubectl get pods -n prod
|
||||||
|
```
|
||||||
|
|
||||||
|
Check the logs of a specific pod copy value for <pod-name> from the command above (--previous flag shows logs of a failing pod, remove it if the pod is not failing):
|
||||||
|
```bash
|
||||||
|
kubectl logs <pod-name> -n prod --previous
|
||||||
|
```
|
||||||
|
|
||||||
|
See the service description:
|
||||||
|
```bash
|
||||||
|
kubectl describe service finance-tracker -n prod
|
||||||
|
```
|
||||||
|
|
||||||
|
Connect to the pod and run a bash shell:
|
||||||
|
```bash
|
||||||
|
kubectl exec -it <pod-name> -n prod -- /bin/bash
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
@@ -536,9 +647,9 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
|
|||||||
|
|
||||||
| Task/Component | Assigned To | Status | Time Spent | Difficulty | Notes |
|
| Task/Component | Assigned To | Status | Time Spent | Difficulty | Notes |
|
||||||
|-------------------------------------------------------------------------------------------------------------------|-------------|----------------|------------|------------|-----------------------------------------------------------------------------------------------------|
|
|-------------------------------------------------------------------------------------------------------------------|-------------|----------------|------------|------------|-----------------------------------------------------------------------------------------------------|
|
||||||
| [Project Setup & Repository](https://github.com/dat515-2025/Group-8#) | Lukas | ✅ Complete | [X hours] | Medium | [Any notes] |
|
| [Project Setup & Repository](https://github.com/dat515-2025/Group-8#) | Lukas | ✅ Complete | 40 Hours | Medium | [Any notes] |
|
||||||
| [Design Document](https://github.com/dat515-2025/Group-8/blob/main/6design/design.md) | Both | ✅ Complete | 4 Hours | Easy | [Any notes] |
|
| [Design Document](https://github.com/dat515-2025/Group-8/blob/main/6design/design.md) | Both | ✅ Complete | 4 Hours | Easy | [Any notes] |
|
||||||
| [Backend API Development](https://github.com/dat515-2025/Group-8/tree/main/7project/backend/app/api) | Dejan | ✅ Complete | 12 hours | Medium | [Any notes] |
|
| [Backend API Development](https://github.com/dat515-2025/Group-8/tree/main/7project/backend/app/api) | Dejan | ✅ Complete | 14 hours | Medium | [Any notes] |
|
||||||
| [Database Setup & Models](https://github.com/dat515-2025/Group-8/tree/main/7project/backend/app/models) | Lukas | ✅ Complete | [X hours] | Medium | [Any notes] |
|
| [Database Setup & Models](https://github.com/dat515-2025/Group-8/tree/main/7project/backend/app/models) | Lukas | ✅ Complete | [X hours] | Medium | [Any notes] |
|
||||||
| [Frontend Development](https://github.com/dat515-2025/Group-8/tree/main/7project/frontend) | Dejan | ✅ Complete | 17 hours | Medium | [Any notes] |
|
| [Frontend Development](https://github.com/dat515-2025/Group-8/tree/main/7project/frontend) | Dejan | ✅ Complete | 17 hours | Medium | [Any notes] |
|
||||||
| [Docker Configuration](https://github.com/dat515-2025/Group-8/blob/main/7project/compose.yml) | Lukas | ✅ Complete | 3 hours | Easy | [Any notes] |
|
| [Docker Configuration](https://github.com/dat515-2025/Group-8/blob/main/7project/compose.yml) | Lukas | ✅ Complete | 3 hours | Easy | [Any notes] |
|
||||||
@@ -579,24 +690,26 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
|
|||||||
|
|
||||||
### Dejan
|
### Dejan
|
||||||
|
|
||||||
| Date | Activity | Hours | Description | Representative Commit / PR |
|
| Date | Activity | Hours | Description | Representative Commit / PR |
|
||||||
|:----------------|:-------------------------|:-------|:--------------------------------------------------------------|:---------------------------------------------------------|
|
|:-----------------|:---------------------|:-------|:----------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------|
|
||||||
| 25.9. | Design | 2 | 6design | |
|
| 25.9. | Design | 2 | 6design | |
|
||||||
| 9.10 to 11.10. | Backend APIs | 14 | Implemented Backend APIs | `PR #26`, `20-create-a-controller-layer-on-backend-side` |
|
| 9.10. to 11.10. | Backend APIs | 14 | Implemented Backend APIs | `PR #26`, `20-create-a-controller-layer-on-backend-side` |
|
||||||
| 13.10 to 15.10. | Frontend Development | 8 | Created user interface mockups | `PR #28`, `frontend basics` |
|
| 13.10. to 15.10. | Frontend Development | 8 | Created user interface mockups | `PR #28`, `frontend basics` |
|
||||||
| Continually | Documentation | 8 | Documenting the dev process | |
|
| 21.10. to 23.10. | Tests, frontend | 10 | Test basics, balance charts, and frontend improvement | `PR #31`, `30 create tests and set up a GitHub pipeline` |
|
||||||
| 21.10 to 23.10 | Tests, frontend | 10 | Test basics, balance charts, and frontend improvement | `PR #31`, `30 create tests and set up a GitHub pipeline` |
|
| 28.10. to 30.10. | CI/CD | 6 | Integrated tests with test database setup on github workflows | `PR #31`, `30 create tests and set up a GitHub pipeline` |
|
||||||
| 28.10 to 30.10 | CI | 6 | Integrated tests with test database setup on github workflows | `PR #28`, `frontend basics` |
|
| 28.10. to 30.10. | Frontend | 8 | UI improvements and exchange rate API integration | `PR #35`, `34 improve frontend functionality` |
|
||||||
| 28.10 to 30.10 | Frontend | 8 | UI improvements and exchange rate API integration | `PR #28`, `frontend basics` |
|
| 29.10. | Backend | 4 | Token invalidation, few fixes | `PR #38`, `fix(backend): implemented jwt token invalidation so users cannot use …` |
|
||||||
| 4.11 to 6.11 | Tests | 6 | Test fixes improvement, more integration and e2e | `PR #28`, `frontend basics` |
|
| 4.11. to 6.11. | Tests | 6 | Test fixes improvement, more integration and e2e | `PR #45`, `feat(test): added more tests ` |
|
||||||
| 4.11 to 6.11 | Frontend | 6 | Fixes, Improved UI, added support for mobile devices | `PR #28`, `frontend basics` |
|
| 4.11. to 6.11. | Frontend | 8 | Fixes, rates API, Improved UI, added support for mobile devices | `PR #41, #44`, `feat(frontend): added CNB API and moved management into a new tab`, `43 fix the UI layout in chrome ` |
|
||||||
| 11.11 | Backend APIs | 4 | Moved rates API, mock bank to Backend, few fixes | `PR #28`, `frontend basics` |
|
| 11.11. | Backend APIs | 4 | Moved rates API, mock bank to Backend, few fixes | `feat(backend): Moved the unirate API to the backend `, `feat(backend): moved mock bank to backend` |
|
||||||
| 11.11 to 12.11 | Tests | 3 | Local testing DB container, few fixes | `PR #28`, `frontend basics` |
|
| 11.11. to 12.11. | Tests | 3 | Local testing DB container, few fixes | `PR #48`, `fix(tests): fixed test runtime errors regarding database connection ` |
|
||||||
| 12.11 | Frontend | 3 | Enabled multiple transaction edits at once, CSAS button state | `PR #28`, `frontend basics` |
|
| 12.11. | Frontend | 3 | Enabled multiple transaction edits at once, CSAS button state | `feat(frontend): implemented multiple transaction selections in UI` |
|
||||||
| 13.11 | Video | 3 | Video | |
|
| 13.11. | Video | 3 | Video | |
|
||||||
| **Total** | | **81** | | |
|
| 25.9. to 14.11. | Documentation | 8 | Documenting the dev process | multiple `feat(docs): report.md update` |
|
||||||
|
| **Total** | | **87** | | |
|
||||||
|
|
||||||
### Group Total: [XXX.X] hours
|
|
||||||
|
### Group Total: 192 hours
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
@@ -604,7 +717,13 @@ curl -H "Authorization: Bearer $TOKEN" http://127.0.0.1:8000/authenticated-route
|
|||||||
|
|
||||||
### What We Learned
|
### What We Learned
|
||||||
|
|
||||||
[Reflect on the key technical and collaboration skills learned during this project]
|
#### Technical
|
||||||
|
- We learned how to use AI to help us with our project.
|
||||||
|
- We learned how to use Copilot for PR reviews.
|
||||||
|
- We learned how to troubleshoot issues with our project in different areas.
|
||||||
|
#### Collaboration
|
||||||
|
- Weekly meetings with the TA were great for syncing up on progress, discussing issues, planning future work.
|
||||||
|
- Using GitHub issues and pull requests was very helpful for keeping track of progress.
|
||||||
|
|
||||||
### Challenges Faced
|
### Challenges Faced
|
||||||
|
|
||||||
@@ -618,6 +737,10 @@ If the deployed module (helm chart for example) was not configured properly, it
|
|||||||
namespace that cannot be deleted.
|
namespace that cannot be deleted.
|
||||||
This was solved by using snapshots in Proxmox and restoring if this happened.
|
This was solved by using snapshots in Proxmox and restoring if this happened.
|
||||||
|
|
||||||
|
#### Not enough time to implement all features
|
||||||
|
Since this course is worth only 5 credits, we often had to prioritize other courses we were attending over this project.
|
||||||
|
In the end, we were able to implement all necessary features.
|
||||||
|
|
||||||
### If We Did This Again
|
### If We Did This Again
|
||||||
|
|
||||||
#### Different framework
|
#### Different framework
|
||||||
@@ -626,6 +749,15 @@ FastAPI lacks usable build in support for database migrations and implementing A
|
|||||||
Tricky was also integrating FastAPI auth system with React frontend, since there is no official project template.
|
Tricky was also integrating FastAPI auth system with React frontend, since there is no official project template.
|
||||||
Using .NET (which we considered initially) would probably solve these issues.
|
Using .NET (which we considered initially) would probably solve these issues.
|
||||||
|
|
||||||
|
#### Private container registry
|
||||||
|
|
||||||
|
Using private container registry would allow us to include environment variables directly in the image during build.
|
||||||
|
This would simplify deployment and CI/CD setup.
|
||||||
|
|
||||||
|
#### Start sooner
|
||||||
|
The weekly meetings helped us to start planning the project earlier and avoid spending too much time on details,
|
||||||
|
but we could have started earlier if we had more time.
|
||||||
|
|
||||||
[What would you do differently? What worked well that you'd keep?]
|
[What would you do differently? What worked well that you'd keep?]
|
||||||
|
|
||||||
### Individual Growth
|
### Individual Growth
|
||||||
@@ -641,15 +773,17 @@ The biggest challenge for me was time tracking since I am used to tracking to pr
|
|||||||
It was also interesting experience to be the one responsible for the initial project structure/design/setup
|
It was also interesting experience to be the one responsible for the initial project structure/design/setup
|
||||||
used not only by myself.
|
used not only by myself.
|
||||||
|
|
||||||
[Personal reflection on growth, challenges, and learning]
|
|
||||||
|
|
||||||
#### [Dejan]
|
#### [Dejan]
|
||||||
Since I do not have a job, this project was probably the most complex one I have ever worked on.
|
|
||||||
It was also the first school project where I was encouraged to use AI.
|
|
||||||
|
|
||||||
Lukas
|
Since I do not have a job and I am more theoretically oriented student (I am more into math, algorithms, cryptography), this project was probably the most complex one I have ever worked on.
|
||||||
|
For me, it was a great experience to work on an actually deployed fullstack app and not only local development, that I was used to from the past.
|
||||||
|
|
||||||
|
It was also a great experience to collaborate with Lukas who has prior experience with app deployment and infrastructure.
|
||||||
|
Thanks to this, I learned a lot new technologies and how to work in a team (First time reviewing PRs).
|
||||||
|
|
||||||
|
It was challenging to wrap my head around the project structure and how everything was connected (And I still think I have some gaps in my knowledge).
|
||||||
|
But I think that if I decide to create my own demo project in the future, I will definitely be able to work on it much more efficiently.
|
||||||
|
|
||||||
[Personal reflection on growth, challenges, and learning]
|
|
||||||
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|||||||
14
7project/src/README.md
Normal file
14
7project/src/README.md
Normal file
@@ -0,0 +1,14 @@
|
|||||||
|
## Folder structure
|
||||||
|
|
||||||
|
- `src/`
|
||||||
|
- `backend/` - Python FastAPI backend application. Described in separate [README](./backend/README.md).
|
||||||
|
- `charts/`
|
||||||
|
- `myapp-chart/` - Helm chart for deploying the application, supports prod and dev environments. Described in
|
||||||
|
separate [README](./charts/README.md).
|
||||||
|
- `frontend/` - React frontend application. Described in separate
|
||||||
|
[README](./frontend/README.md).
|
||||||
|
- `tofu/` - Terraform/OpenTofu services deployment configurations. Described in separate
|
||||||
|
[README](./tofu/README.md).
|
||||||
|
- `compose.yaml` - Docker Compose file for local development
|
||||||
|
- `create_migration.sh` - script to create new Alembic database migration
|
||||||
|
- `upgrade_database.sh` - script to upgrade database to latest Alembic revision
|
||||||
23
7project/src/backend/README.md
Normal file
23
7project/src/backend/README.md
Normal file
@@ -0,0 +1,23 @@
|
|||||||
|
# Backend
|
||||||
|
|
||||||
|
This directory contains the backend code for the project. It is built using Python and FastAPI framework and with
|
||||||
|
database migrations support using Alembic.
|
||||||
|
|
||||||
|
## Directory structure
|
||||||
|
|
||||||
|
- `alembic/` - database migrations
|
||||||
|
- `app/` - main application code
|
||||||
|
- `api/` - API endpoints - routers/controllers with request handling logic
|
||||||
|
- `core/` - core application logic - database session management, security
|
||||||
|
- `models/` - database models
|
||||||
|
- `schemas/` - Endpoint schemas
|
||||||
|
- `services/` - utilities for various tasks
|
||||||
|
- `workers/` - background tasks
|
||||||
|
- `app.py` - FastAPI startup script
|
||||||
|
- `celery_app.py` - Celery startup script
|
||||||
|
- `tests/` - tests
|
||||||
|
- `docker-compose.test.yml` - docker compose for testing database
|
||||||
|
- `Dockerfile` - production Dockerfile
|
||||||
|
- `main.py` - App entrypoint
|
||||||
|
- `requirements.txt` - Python dependencies
|
||||||
|
- `test_locally.sh` - script to run tests with temporary database
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
import app.celery_app # noqa: F401
|
|
||||||
from app.workers.celery_tasks import send_email
|
|
||||||
|
|
||||||
|
|
||||||
def enqueue_email(to: str, subject: str, body: str) -> None:
|
|
||||||
send_email.delay(to, subject, body)
|
|
||||||
@@ -49,4 +49,4 @@ def decode_and_verify_jwt(token: str, secret: str) -> dict:
|
|||||||
secret,
|
secret,
|
||||||
algorithms=["HS256"],
|
algorithms=["HS256"],
|
||||||
options={"verify_aud": False},
|
options={"verify_aud": False},
|
||||||
) # verify_exp is True by default
|
) # verify_exp is True by default
|
||||||
|
|||||||
@@ -14,11 +14,10 @@ from httpx_oauth.oauth2 import BaseOAuth2
|
|||||||
|
|
||||||
from app.models.user import User
|
from app.models.user import User
|
||||||
from app.oauth.bank_id import BankID
|
from app.oauth.bank_id import BankID
|
||||||
from app.oauth.csas import CSASOAuth
|
from app.workers.celery_tasks import send_email
|
||||||
from app.oauth.custom_openid import CustomOpenID
|
from app.oauth.custom_openid import CustomOpenID
|
||||||
from app.oauth.moje_id import MojeIDOAuth
|
from app.oauth.moje_id import MojeIDOAuth
|
||||||
from app.services.db import get_user_db
|
from app.services.db import get_user_db
|
||||||
from app.core.queue import enqueue_email
|
|
||||||
|
|
||||||
SECRET = os.getenv("SECRET", "CHANGE_ME_SECRET")
|
SECRET = os.getenv("SECRET", "CHANGE_ME_SECRET")
|
||||||
|
|
||||||
@@ -87,7 +86,7 @@ class UserManager(UUIDIDMixin, BaseUserManager[User, uuid.UUID]):
|
|||||||
"Pokud jsi registraci neprováděl(a), tento email ignoruj.\n"
|
"Pokud jsi registraci neprováděl(a), tento email ignoruj.\n"
|
||||||
)
|
)
|
||||||
try:
|
try:
|
||||||
enqueue_email(to=user.email, subject=subject, body=body)
|
send_email.delay(user.email, subject, body)
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
print("[Email Fallback] To:", user.email)
|
print("[Email Fallback] To:", user.email)
|
||||||
print("[Email Fallback] Subject:", subject)
|
print("[Email Fallback] Subject:", subject)
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
import uvicorn
|
import uvicorn
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
uvicorn.run("app.app:app", host="0.0.0.0", log_level="info")
|
uvicorn.run("app.app:fastApi", host="0.0.0.0", log_level="info")
|
||||||
|
|||||||
@@ -34,15 +34,16 @@ def test_authenticated_route_requires_auth(client):
|
|||||||
async def test_on_after_request_verify_enqueues_email(monkeypatch):
|
async def test_on_after_request_verify_enqueues_email(monkeypatch):
|
||||||
calls = {}
|
calls = {}
|
||||||
|
|
||||||
def fake_enqueue_email(to: str, subject: str, body: str):
|
class FakeCeleryTask:
|
||||||
calls.setdefault("emails", []).append({
|
def delay(to: str, subject: str, body: str):
|
||||||
"to": to,
|
calls.setdefault("emails", []).append({
|
||||||
"subject": subject,
|
"to": to,
|
||||||
"body": body,
|
"subject": subject,
|
||||||
})
|
"body": body,
|
||||||
|
})
|
||||||
|
|
||||||
# Patch the enqueue_email used inside user_service
|
# Patch the enqueue_email used inside user_service
|
||||||
monkeypatch.setattr(user_service, "enqueue_email", fake_enqueue_email)
|
monkeypatch.setattr(user_service, "send_email", FakeCeleryTask)
|
||||||
|
|
||||||
class DummyUser:
|
class DummyUser:
|
||||||
def __init__(self, email):
|
def __init__(self, email):
|
||||||
|
|||||||
30
7project/src/charts/README.md
Normal file
30
7project/src/charts/README.md
Normal file
@@ -0,0 +1,30 @@
|
|||||||
|
# Helm chart deployment
|
||||||
|
|
||||||
|
This directory contains a Helm chart for deploying the app to a cluster, it support bot production and preview
|
||||||
|
deployment.
|
||||||
|
|
||||||
|
## Directory Structure
|
||||||
|
|
||||||
|
- `myapp-chart/`
|
||||||
|
- `templates/`
|
||||||
|
- `app-deployment.yaml` - Kubernetes Deployment for the application
|
||||||
|
- `cron.yaml` - cronjob for periodic tasks - periodically calls app endpoint
|
||||||
|
- `database.yaml` - Creates database using MariaDB operator. Production database is kept, but preview/dev
|
||||||
|
database is dropped after uninstalling the chart.
|
||||||
|
- `database-grant.yaml` - Defines rights for the database user
|
||||||
|
- `database-user.yaml` - Creates database user
|
||||||
|
- `monitoring.yaml` - Adds /metrics endpoint to Prometheus scraping
|
||||||
|
- `prod.yaml` - Application secrets
|
||||||
|
- `rabbitmq-cluster.yaml` - Defines RabbitMQ cluster for this deployment
|
||||||
|
- `rabbitmq-permission.yalm` - Defines RabbitMQ user permissions
|
||||||
|
- `rabbitmq-queue.yaml` - Defines RabbitMQ queue
|
||||||
|
- `rabbitmq-user.yaml` - Defines RabbitMQ user
|
||||||
|
- `rabbitmq-user-secret.yaml` - Defines RabbitMQ user secret
|
||||||
|
- `service.yaml` - Kubernetes Service for the application
|
||||||
|
- `tunnel.yaml` - Cloudflare tunnel for accessing the application¨
|
||||||
|
- `worker-deployment.yaml` - Kubernetes Deployment for the Celery worker, uses same image as the app-deployment,
|
||||||
|
but with different entrypoint
|
||||||
|
- `Chart.yaml` - Helm chart metadata
|
||||||
|
- `values.yaml` - list of all configurable values
|
||||||
|
- `values-dev.yaml` - default values for development/preview deployment
|
||||||
|
- `values-prod.yaml` - default values for production deployment
|
||||||
@@ -1,73 +1,21 @@
|
|||||||
# React + TypeScript + Vite
|
# React + TypeScript + Vite
|
||||||
|
|
||||||
This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
|
This directory contains the frontend code.
|
||||||
|
|
||||||
Currently, two official plugins are available:
|
## Directory Structure
|
||||||
|
|
||||||
- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) (or [oxc](https://oxc.rs) when used in [rolldown-vite](https://vite.dev/guide/rolldown)) for Fast Refresh
|
- `public/` - static files
|
||||||
- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
|
- `src/` - frontend code
|
||||||
|
- `assets/` - static assets
|
||||||
## React Compiler
|
- `pages/` - React pages
|
||||||
|
- `api.ts` - API client
|
||||||
The React Compiler is not enabled on this template because of its impact on dev & build performances. To add it, see [this documentation](https://react.dev/learn/react-compiler/installation).
|
- `App.tsx` - React app
|
||||||
|
- `main.tsx` - entry point
|
||||||
## Expanding the ESLint configuration
|
- `index.css` - global styles
|
||||||
|
- `config.ts` - configuration
|
||||||
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
|
- `ui.css` - UI styles
|
||||||
|
- `vite.config.ts` - Vite configuration
|
||||||
```js
|
- `package.json` - NPM dependencies
|
||||||
export default defineConfig([
|
- `tsconfig.json` - TypeScript configuration
|
||||||
globalIgnores(['dist']),
|
- `index.html` - HTML template
|
||||||
{
|
-
|
||||||
files: ['**/*.{ts,tsx}'],
|
|
||||||
extends: [
|
|
||||||
// Other configs...
|
|
||||||
|
|
||||||
// Remove tseslint.configs.recommended and replace with this
|
|
||||||
tseslint.configs.recommendedTypeChecked,
|
|
||||||
// Alternatively, use this for stricter rules
|
|
||||||
tseslint.configs.strictTypeChecked,
|
|
||||||
// Optionally, add this for stylistic rules
|
|
||||||
tseslint.configs.stylisticTypeChecked,
|
|
||||||
|
|
||||||
// Other configs...
|
|
||||||
],
|
|
||||||
languageOptions: {
|
|
||||||
parserOptions: {
|
|
||||||
project: ['./tsconfig.node.json', './tsconfig.app.json'],
|
|
||||||
tsconfigRootDir: import.meta.dirname,
|
|
||||||
},
|
|
||||||
// other options...
|
|
||||||
},
|
|
||||||
},
|
|
||||||
])
|
|
||||||
```
|
|
||||||
|
|
||||||
You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
|
|
||||||
|
|
||||||
```js
|
|
||||||
// eslint.config.js
|
|
||||||
import reactX from 'eslint-plugin-react-x'
|
|
||||||
import reactDom from 'eslint-plugin-react-dom'
|
|
||||||
|
|
||||||
export default defineConfig([
|
|
||||||
globalIgnores(['dist']),
|
|
||||||
{
|
|
||||||
files: ['**/*.{ts,tsx}'],
|
|
||||||
extends: [
|
|
||||||
// Other configs...
|
|
||||||
// Enable lint rules for React
|
|
||||||
reactX.configs['recommended-typescript'],
|
|
||||||
// Enable lint rules for React DOM
|
|
||||||
reactDom.configs.recommended,
|
|
||||||
],
|
|
||||||
languageOptions: {
|
|
||||||
parserOptions: {
|
|
||||||
project: ['./tsconfig.node.json', './tsconfig.app.json'],
|
|
||||||
tsconfigRootDir: import.meta.dirname,
|
|
||||||
},
|
|
||||||
// other options...
|
|
||||||
},
|
|
||||||
},
|
|
||||||
])
|
|
||||||
```
|
|
||||||
|
|||||||
20
7project/src/tofu/README.md
Normal file
20
7project/src/tofu/README.md
Normal file
@@ -0,0 +1,20 @@
|
|||||||
|
# Terraform/OpenTofu IaC
|
||||||
|
|
||||||
|
This directory contains infrastructure configuration files and modules for underlying services.
|
||||||
|
|
||||||
|
## Directory Structure
|
||||||
|
|
||||||
|
- `modules/` - separated modules for different services
|
||||||
|
- `cert-manager/` - module for deploying Cert-Manager
|
||||||
|
- `cloudflare/` - module for Cloudflare tunnels operator - allows to expose services via Cloudflare tunnels
|
||||||
|
- `maxscale/` - module for MariaDB Operator set up for MaxScale and 3 nodes, backups and phpMyAdmin. PHPMyAdmin is
|
||||||
|
available at mysql.YOU_DOMAIN, MaxScale UI at maxscale.YOU_DOMAIN
|
||||||
|
- `metallb/` - module for MetalLB load balancer
|
||||||
|
- `metrics-server/` - module for Kubernetes Metrics Server
|
||||||
|
- `prometheus/` - module for Prometheus and Grafana - monitoring stack with grafana available at grafana.YOU_DOMAIN
|
||||||
|
- `rabbitmq/` - module for RabbitMQ message queue cluster
|
||||||
|
- `redis/` - module for Redis cluster, not used currently
|
||||||
|
- `storage/` - module for Longhorn file storage
|
||||||
|
- `main.tf` - main deployment configuration
|
||||||
|
- `variables.tf` - deployment variables
|
||||||
|
- `terraform.tfvars.example` - example variables file
|
||||||
@@ -31,5 +31,5 @@ resource "helm_release" "longhorn" {
|
|||||||
chart = "longhorn"
|
chart = "longhorn"
|
||||||
namespace = "longhorn-system"
|
namespace = "longhorn-system"
|
||||||
version = "1.9.1"
|
version = "1.9.1"
|
||||||
timeout = 3600
|
timeout = 300
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -95,13 +95,6 @@ variable "cloudflare_account_id" {
|
|||||||
nullable = false
|
nullable = false
|
||||||
}
|
}
|
||||||
|
|
||||||
variable "argocd_admin_password" {
|
|
||||||
type = string
|
|
||||||
nullable = false
|
|
||||||
sensitive = true
|
|
||||||
description = "ArgoCD admin password"
|
|
||||||
}
|
|
||||||
|
|
||||||
variable "rabbitmq-password" {
|
variable "rabbitmq-password" {
|
||||||
type = string
|
type = string
|
||||||
nullable = false
|
nullable = false
|
||||||
|
|||||||
Reference in New Issue
Block a user