mirror of
https://github.com/dat515-2025/Group-8.git
synced 2026-03-22 15:12:08 +01:00
Compare commits
6 Commits
merge/core
...
515106b238
| Author | SHA1 | Date | |
|---|---|---|---|
|
515106b238 | ||
|
|
b5290119e9 | ||
| 0beb889f5e | |||
|
|
0a96c32c93 | ||
|
|
f1034f6ed5 | ||
| 0f729d28d1 |
@@ -7,64 +7,64 @@ Focus on areas that align with your project goals and interests.
|
||||
The core deliverables are required.
|
||||
This means that you must get at least 2 points for each item in this category.
|
||||
|
||||
| **Category** | **Item** | **Max Points** | **Points** | **Comments** |
|
||||
|----------------------------------| --------------------------------------- | -------------- |-------------------------------------------------| |
|
||||
| **Core Deliverables (Required)** | | | | |
|
||||
| Codebase & Organization | Well-organized project structure | 5 | 5 | |
|
||||
| | Clean, readable code | 5 | 4 | |
|
||||
| | Use planning tool (e.g., GitHub issues) | 5 | 4 | |
|
||||
| | Proper version control usage | 5 | 5 | |
|
||||
| 23 | Complete source code | 5 | 5 | |
|
||||
| Documentation | Comprehensive reproducibility report | 10 | 4-5 | |
|
||||
| | Updated design document | 5 | 2 | |
|
||||
| | Clear build/deployment instructions | 5 | 2 | |
|
||||
| | Troubleshooting guide | 5 | 1 | |
|
||||
| | Completed self-assessment table | 5 | 2 | |
|
||||
| 14 | Hour sheets for all members | 5 | 3 | |
|
||||
| Presentation Video | Project demonstration | 5 | 0 | |
|
||||
| | Code walk-through | 5 | 0 | |
|
||||
| 0 | Deployment showcase | 5 | 0 | |
|
||||
| **Technical Implementation** | | | | |
|
||||
| Application Functionality | Basic functionality works | 10 | 8 | |
|
||||
| | Advanced features implemented | 10 | 0 | |
|
||||
| | Error handling & robustness | 10 | 4 | |
|
||||
| 16 | User-friendly interface | 5 | 4 | |
|
||||
| Backend & Architecture | Stateless web server | 5 | 5 | |
|
||||
| | Stateful application | 10 | ? WHAT DOES THIS MEAN | |
|
||||
| | Database integration | 10 | 10 | |
|
||||
| | API design | 5 | 5 | |
|
||||
| 20 | Microservices architecture | 10 | 0 | |
|
||||
| Cloud Integration | Basic cloud deployment | 10 | 10 | |
|
||||
| | Cloud APIs usage | 10 | ? WHAT DOES THIS MEAN | |
|
||||
| | Serverless components | 10 | 0 | |
|
||||
| 10 | Advanced cloud services | 5 | 0 | |
|
||||
| **DevOps & Deployment** | | | | |
|
||||
| Containerization | Basic Dockerfile | 5 | 5 | |
|
||||
| | Optimized Dockerfile | 5 | 0 | |
|
||||
| | Docker Compose | 5 | 5 - dev only | |
|
||||
| 15 | Persistent storage | 5 | 5 | |
|
||||
| Deployment & Scaling | Manual deployment | 5 | 5 | |
|
||||
| | Automated deployment | 5 | 5 | |
|
||||
| | Multiple replicas | 5 | 5 | |
|
||||
| 20 | Kubernetes deployment | 10 | 10 | |
|
||||
| **Quality Assurance** | | | | |
|
||||
| Testing | Unit tests | 5 | 2 | |
|
||||
| | Integration tests | 5 | 2 | |
|
||||
| | End-to-end tests | 5 | 5 | |
|
||||
| 9 | Performance testing | 5 | 0 | |
|
||||
| Monitoring & Operations | Health checks | 5 | 5 | |
|
||||
| | Logging | 5 | 2 - only to terminal add logstash | |
|
||||
| 9 | Metrics/Monitoring | 5 | 2 - only DB, need to create Prometheus endpoint | |
|
||||
| Security | HTTPS/TLS | 5 | 5 | |
|
||||
| | Authentication | 5 | 5 | |
|
||||
| 15 | Authorization | 5 | 5 | |
|
||||
| **Innovation & Excellence** | | | | |
|
||||
| Advanced Features and | AI/ML Integration | 10 | 0 | |
|
||||
| Technical Excellence | Real-time features | 10 | 0 | |
|
||||
| | Creative problem solving | 10 | ? | |
|
||||
| | Performance optimization | 5 | 2 | |
|
||||
| 2 | Exceptional user experience | 5 | 0 | |
|
||||
| **Total** | | **255** | **153** | |
|
||||
| **Category** | **Item** | **Max Points** | **Points** | **Comments** |
|
||||
|----------------------------------| --------------------------------------- | -------------- |-------------------------------------------------|---------------|
|
||||
| **Core Deliverables (Required)** | | | | |
|
||||
| Codebase & Organization | Well-organized project structure | 5 | 5 | |
|
||||
| | Clean, readable code | 5 | 4 | |
|
||||
| | Use planning tool (e.g., GitHub issues) | 5 | 4 | |
|
||||
| | Proper version control usage | 5 | 5 | |
|
||||
| 23 | Complete source code | 5 | 5 | |
|
||||
| Documentation | Comprehensive reproducibility report | 10 | 4-5 | |
|
||||
| | Updated design document | 5 | 2 | |
|
||||
| | Clear build/deployment instructions | 5 | 2 | |
|
||||
| | Troubleshooting guide | 5 | 1 | |
|
||||
| | Completed self-assessment table | 5 | 2 | |
|
||||
| 14 | Hour sheets for all members | 5 | 3 | |
|
||||
| Presentation Video | Project demonstration | 5 | 0 | |
|
||||
| | Code walk-through | 5 | 0 | |
|
||||
| 0 | Deployment showcase | 5 | 0 | |
|
||||
| **Technical Implementation** | | | | |
|
||||
| Application Functionality | Basic functionality works | 10 | 8 | |
|
||||
| | Advanced features implemented | 10 | 0 | |
|
||||
| | Error handling & robustness | 10 | 4 | |
|
||||
| 16 | User-friendly interface | 5 | 4 | |
|
||||
| Backend & Architecture | Stateless web server | 5 | 5 | |
|
||||
| | Stateful application | 10 | ? WHAT DOES THIS MEAN | |
|
||||
| | Database integration | 10 | 10 | |
|
||||
| | API design | 5 | 5 | |
|
||||
| 20 | Microservices architecture | 10 | 0 | |
|
||||
| Cloud Integration | Basic cloud deployment | 10 | 10 | |
|
||||
| | Cloud APIs usage | 10 | ? WHAT DOES THIS MEAN | |
|
||||
| | Serverless components | 10 | 0 | |
|
||||
| 10 | Advanced cloud services | 5 | 0 | |
|
||||
| **DevOps & Deployment** | | | | |
|
||||
| Containerization | Basic Dockerfile | 5 | 5 | |
|
||||
| | Optimized Dockerfile | 5 | 0 | |
|
||||
| | Docker Compose | 5 | 5 - dev only | |
|
||||
| 15 | Persistent storage | 5 | 5 | |
|
||||
| Deployment & Scaling | Manual deployment | 5 | 5 | |
|
||||
| | Automated deployment | 5 | 5 | |
|
||||
| | Multiple replicas | 5 | 5 | |
|
||||
| 20 | Kubernetes deployment | 10 | 10 | |
|
||||
| **Quality Assurance** | | | | |
|
||||
| Testing | Unit tests | 5 | 2 | |
|
||||
| | Integration tests | 5 | 2 | |
|
||||
| | End-to-end tests | 5 | 5 | |
|
||||
| 9 | Performance testing | 5 | 0 | |
|
||||
| Monitoring & Operations | Health checks | 5 | 5 | |
|
||||
| | Logging | 5 | 2 - only to terminal add logstash | |
|
||||
| 9 | Metrics/Monitoring | 5 | 2 - only DB, need to create Prometheus endpoint | |
|
||||
| Security | HTTPS/TLS | 5 | 5 | |
|
||||
| | Authentication | 5 | 5 | |
|
||||
| 15 | Authorization | 5 | 5 | |
|
||||
| **Innovation & Excellence** | | | | |
|
||||
| Advanced Features and | AI/ML Integration | 10 | 0 | |
|
||||
| Technical Excellence | Real-time features | 10 | 0 | |
|
||||
| | Creative problem solving | 10 | ? | |
|
||||
| | Performance optimization | 5 | 2 | |
|
||||
| 2 | Exceptional user experience | 5 | 0 | |
|
||||
| **Total** | | **255** | **153** | |
|
||||
|
||||
## Grading Scale
|
||||
|
||||
|
||||
@@ -47,7 +47,6 @@ flowchart TB
|
||||
svc <-- HTTP request/response --> api[("UniRate API")]
|
||||
client <-- HTTP request/response --> n2
|
||||
```
|
||||
|
||||
The workflow works in the following way:
|
||||
|
||||
- Client connects to the frontend. After login, frontend automatically fetches the stored transactions from
|
||||
@@ -56,6 +55,60 @@ The workflow works in the following way:
|
||||
using background worker.
|
||||
- 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
|
||||
|
||||
- The stored transactions are encrypted in the DB for security reasons.
|
||||
@@ -79,6 +132,14 @@ The workflow works in the following way:
|
||||
etc.).
|
||||
- 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
|
||||
|
||||
- Backend: Python, FastAPI, FastAPI Users, SQLAlchemy, Pydantic, Alembic, Celery
|
||||
@@ -173,7 +234,7 @@ You can run the project with Docker Compose and Python virtual environment for t
|
||||
|
||||
```bash
|
||||
git clone https://github.com/dat515-2025/Group-8.git
|
||||
cd Group-8/7project
|
||||
cd Group-8/7project/src
|
||||
```
|
||||
|
||||
### 2) Install dependencies
|
||||
@@ -202,10 +263,10 @@ bash upgrade_database.sh
|
||||
|
||||
### 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
|
||||
cd backend
|
||||
|
||||
#TODO: set env variables
|
||||
uvicorn app.app:fastApi --reload --host 0.0.0.0 --port 8000
|
||||
```
|
||||
|
||||
@@ -236,7 +297,7 @@ App is separated into backend and frontend so it also needs to be built separate
|
||||
and frontend is deployed as static files.
|
||||
|
||||
```bash
|
||||
cd 7project/backend
|
||||
cd 7project/src/backend
|
||||
# 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
|
||||
docker buildx build --platform linux/amd64,linux/arm64 -t CHANGE_ME --push .
|
||||
@@ -258,7 +319,7 @@ via GitHub actions and Helm chart. Frontend files are deployed to Cloudflare pag
|
||||
|
||||
### 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)
|
||||
running on top of Proxmox VE.
|
||||
|
||||
@@ -526,6 +587,7 @@ npm run dev in 7project/src/frontend
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
||||
### Common Issues
|
||||
|
||||
#### Issue 1: Unable to apply Cloudflare terraform module
|
||||
@@ -550,10 +612,29 @@ by either hitting docker hub rate limits or by docker hub being down.
|
||||
|
||||
### Debug Commands
|
||||
|
||||
Get a detailed description of the Deployment:
|
||||
```bash
|
||||
# Useful commands for debugging
|
||||
# Log viewing commands
|
||||
# Service status checks
|
||||
kubectl describe deployment finance-tracker -n prod
|
||||
```
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
---
|
||||
@@ -566,9 +647,9 @@ by either hitting docker hub rate limits or by docker hub being down.
|
||||
|
||||
| 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] |
|
||||
| [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] |
|
||||
| [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] |
|
||||
@@ -609,24 +690,26 @@ by either hitting docker hub rate limits or by docker hub being down.
|
||||
|
||||
### Dejan
|
||||
|
||||
| Date | Activity | Hours | Description | Representative Commit / PR |
|
||||
|:----------------|:---------------------|:-------|:--------------------------------------------------------------|:---------------------------------------------------------|
|
||||
| 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` |
|
||||
| 13.10 to 15.10. | Frontend Development | 8 | Created user interface mockups | `PR #28`, `frontend basics` |
|
||||
| Continually | Documentation | 7 | 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` |
|
||||
| 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 #28`, `frontend basics` |
|
||||
| 4.11 to 6.11 | Tests | 6 | Test fixes improvement, more integration and e2e | `PR #28`, `frontend basics` |
|
||||
| 4.11 to 6.11 | Frontend | 6 | Fixes, Improved UI, added support for mobile devices | `PR #28`, `frontend basics` |
|
||||
| 11.11 | Backend APIs | 4 | Moved rates API, mock bank to Backend, few fixes | `PR #28`, `frontend basics` |
|
||||
| 11.11 to 12.11 | Tests | 3 | Local testing DB container, few fixes | `PR #28`, `frontend basics` |
|
||||
| 12.11 | Frontend | 3 | Enabled multiple transaction edits at once, CSAS button state | `PR #28`, `frontend basics` |
|
||||
| 13.11 | Video | 3 | Video | |
|
||||
| **Total** | | **80** | | |
|
||||
| Date | Activity | Hours | Description | Representative Commit / PR |
|
||||
|:-----------------|:---------------------|:-------|:----------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------|
|
||||
| 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` |
|
||||
| 13.10. to 15.10. | Frontend Development | 8 | Created user interface mockups | `PR #28`, `frontend basics` |
|
||||
| 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. | Frontend | 8 | UI improvements and exchange rate API integration | `PR #35`, `34 improve frontend functionality` |
|
||||
| 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 #45`, `feat(test): added more tests ` |
|
||||
| 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 | `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 #48`, `fix(tests): fixed test runtime errors regarding database connection ` |
|
||||
| 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 | |
|
||||
| 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
|
||||
|
||||
---
|
||||
|
||||
@@ -634,7 +717,13 @@ by either hitting docker hub rate limits or by docker hub being down.
|
||||
|
||||
### 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
|
||||
|
||||
@@ -648,6 +737,10 @@ If the deployed module (helm chart for example) was not configured properly, it
|
||||
namespace that cannot be deleted.
|
||||
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
|
||||
|
||||
#### Different framework
|
||||
@@ -661,6 +754,10 @@ Using .NET (which we considered initially) would probably solve these issues.
|
||||
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?]
|
||||
|
||||
### Individual Growth
|
||||
@@ -678,8 +775,14 @@ used not only by myself.
|
||||
|
||||
#### [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.
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -1,23 +1,14 @@
|
||||
## Folder structure
|
||||
|
||||
- `src/`
|
||||
- `backend/`
|
||||
- `alembic/` - database migrations
|
||||
- `app/` - main application code
|
||||
- `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
|
||||
- `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
|
||||
- `frontend/` - React frontend application
|
||||
- `tofu/` - Terraform/OpenTofu services deployment configurations
|
||||
- `modules/` - separated modules for different services
|
||||
- `main.tf` - main deployment configuration
|
||||
- `variables.tf` - deployment variables
|
||||
- `terraform.tfvars.example` - example variables file
|
||||
- `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,73 +1,21 @@
|
||||
# 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
|
||||
- [@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
|
||||
|
||||
## React Compiler
|
||||
|
||||
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).
|
||||
|
||||
## Expanding the ESLint configuration
|
||||
|
||||
If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
|
||||
|
||||
```js
|
||||
export default defineConfig([
|
||||
globalIgnores(['dist']),
|
||||
{
|
||||
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...
|
||||
},
|
||||
},
|
||||
])
|
||||
```
|
||||
- `public/` - static files
|
||||
- `src/` - frontend code
|
||||
- `assets/` - static assets
|
||||
- `pages/` - React pages
|
||||
- `api.ts` - API client
|
||||
- `App.tsx` - React app
|
||||
- `main.tsx` - entry point
|
||||
- `index.css` - global styles
|
||||
- `config.ts` - configuration
|
||||
- `ui.css` - UI styles
|
||||
- `vite.config.ts` - Vite configuration
|
||||
- `package.json` - NPM dependencies
|
||||
- `tsconfig.json` - TypeScript configuration
|
||||
- `index.html` - HTML template
|
||||
-
|
||||
|
||||
Reference in New Issue
Block a user