From 2bc03bcd5b2dcbb2d96fe6718bcb21beb7bde722 Mon Sep 17 00:00:00 2001 From: ribardej Date: Wed, 8 Oct 2025 17:17:28 +0200 Subject: [PATCH] feat(infrastructure): add documentation markdown files --- 7project/checklist.md | 81 +++++++++++ 7project/meetings.md | 50 +++++++ 7project/report.md | 302 ++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 433 insertions(+) create mode 100644 7project/checklist.md create mode 100644 7project/meetings.md create mode 100644 7project/report.md diff --git a/7project/checklist.md b/7project/checklist.md new file mode 100644 index 0000000..8160c20 --- /dev/null +++ b/7project/checklist.md @@ -0,0 +1,81 @@ +# Project Evaluation Checklist + +The group earn points by completing items from the categories below. +You are not expected to complete all items. +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** | +| -------------------------------- | --------------------------------------- | -------------- | ---------------- | +| **Core Deliverables (Required)** | | | | +| Codebase & Organization | Well-organized project structure | 5 | | +| | Clean, readable code | 5 | | +| | Use planning tool (e.g., GitHub issues) | 5 | | +| | Proper version control usage | 5 | | +| | Complete source code | 5 | | +| Documentation | Comprehensive reproducibility report | 10 | | +| | Updated design document | 5 | | +| | Clear build/deployment instructions | 5 | | +| | Troubleshooting guide | 5 | | +| | Completed self-assessment table | 5 | | +| | Hour sheets for all members | 5 | | +| Presentation Video | Project demonstration | 5 | | +| | Code walk-through | 5 | | +| | Deployment showcase | 5 | | +| **Technical Implementation** | | | | +| Application Functionality | Basic functionality works | 10 | | +| | Advanced features implemented | 10 | | +| | Error handling & robustness | 10 | | +| | User-friendly interface | 5 | | +| Backend & Architecture | Stateless web server | 5 | | +| | Stateful application | 10 | | +| | Database integration | 10 | | +| | API design | 5 | | +| | Microservices architecture | 10 | | +| Cloud Integration | Basic cloud deployment | 10 | | +| | Cloud APIs usage | 10 | | +| | Serverless components | 10 | | +| | Advanced cloud services | 5 | | +| **DevOps & Deployment** | | | | +| Containerization | Basic Dockerfile | 5 | | +| | Optimized Dockerfile | 5 | | +| | Docker Compose | 5 | | +| | Persistent storage | 5 | | +| Deployment & Scaling | Manual deployment | 5 | | +| | Automated deployment | 5 | | +| | Multiple replicas | 5 | | +| | Kubernetes deployment | 10 | | +| **Quality Assurance** | | | | +| Testing | Unit tests | 5 | | +| | Integration tests | 5 | | +| | End-to-end tests | 5 | | +| | Performance testing | 5 | | +| Monitoring & Operations | Health checks | 5 | | +| | Logging | 5 | | +| | Metrics/Monitoring | 5 | | +| Security | HTTPS/TLS | 5 | | +| | Authentication | 5 | | +| | Authorization | 5 | | +| **Innovation & Excellence** | | | | +| Advanced Features and | AI/ML Integration | 10 | | +| Technical Excellence | Real-time features | 10 | | +| | Creative problem solving | 10 | | +| | Performance optimization | 5 | | +| | Exceptional user experience | 5 | | +| **Total** | | **255** | **[Your Total]** | + +## Grading Scale + +- **Minimum Required: 100 points** +- **Maximum: 200+ points** + +| Grade | Points | +| ----- | -------- | +| A | 180-200+ | +| B | 160-179 | +| C | 140-159 | +| D | 120-139 | +| E | 100-119 | +| F | 0-99 | \ No newline at end of file diff --git a/7project/meetings.md b/7project/meetings.md new file mode 100644 index 0000000..7fa55bb --- /dev/null +++ b/7project/meetings.md @@ -0,0 +1,50 @@ +# Weekly Meeting Notes + +- Group 8 - Personal finance tracker +- Mentor: Jaychander + +Keep all meeting notes in the `meetings.md` file in your project folder. +Just copy the template below for each weekly meeting and fill in the details. + +## Administrative Info + +- Date: 2025-10-08 +- Attendees: Dejan Ribarovski, Lukas Trkan +- Notetaker: Dejan Ribarovski + +## Progress Update (Before Meeting) + +Summary of what has been accomplished since the last meeting in the following categories. + +### Coding + +Lukas has implemented the template source directories, source files and config files necessary for deployment +- docker compose for database, redis cache and rabbit MQ +- tofu +- backend template +- frontend template +- charts templates + +### Documentation +- Created GitHub issues for the next steps +- Added this document + checklist and report + +## Questions and Topics for Discussion (Before Meeting) + +Prepare 3-5 questions and topics you want to discuss with your mentor. + +1. Anything we should add structure-wise? +2. Anything you would like us to prioritize until next week? +3. Question 3 + +## Discussion Notes (During Meeting) + +## Action Items for Next Week (During Meeting) + +Last 3 minutes of the meeting, summarize action items. + +- [ ] Action Item 1 +- [ ] Action Item 2 +- [ ] Action Item 3 + +--- \ No newline at end of file diff --git a/7project/report.md b/7project/report.md new file mode 100644 index 0000000..1fc4231 --- /dev/null +++ b/7project/report.md @@ -0,0 +1,302 @@ +# Project Report + +> **Instructions**: +> This template provides the structure for your project report. +> Replace the placeholder text with your actual content. +> Remove instructions that are not relevant for your project, but leave the headings along with a (NA) label. + +## Project Overview + +**Project Name**: [Your project name] + +**Group Members**: + +- Student number, Name, GitHub username +- Student number, Name, GitHub username +- Student number, Name, GitHub username + +**Brief Description**: +[2-3 sentences describing what your application does and its main purpose] + +## Architecture Overview + +### High-Level Architecture + +[Describe the overall system architecture. Consider including a diagram using mermaid or linking to an image] + +```mermaid +graph TD + A[Component A] --> B[Component B] + B --> C[Component C] +``` + +### Components + +- **Component 1**: [Description of what this component does] +- **Component 2**: [Description of what this component does] +- **Component 3**: [Description of what this component does] + +### Technologies Used + +- **Backend**: [e.g., Go, Node.js, Python] +- **Database**: [e.g., PostgreSQL, MongoDB, Redis] +- **Cloud Services**: [e.g., AWS EC2, Google Cloud Run, Azure Functions] +- **Container Orchestration**: [e.g., Docker, Kubernetes] +- **Other**: [List other significant technologies] + +## Prerequisites + +### System Requirements + +- Operating System: [e.g., Linux, macOS, Windows] +- Minimum RAM: [e.g., 8GB] +- Storage: [e.g., 10GB free space] + +### Required Software + +- [Software 1] (version X.X or higher) +- [Software 2] (version X.X or higher) +- [etc.] + +### Dependencies + +```bash +# List key dependencies that need to be installed +# For example: +# Docker Engine 20.10+ +# Node.js 18+ +# Go 1.25+ +``` + +## Build Instructions + +### 1. Clone the Repository + +```bash +git clone [your-repository-url] +cd [repository-name] +``` + +### 2. Install Dependencies + +```bash +# Provide step-by-step commands +# For example: +# npm install +# go mod download +``` + +### 3. Build the Application + +```bash +# Provide exact build commands +# For example: +# make build +# docker build -t myapp . +``` + +### 4. Configuration + +```bash +# Any configuration steps needed +# Environment variables to set +# Configuration files to create +``` + +## Deployment Instructions + +### Local Deployment + +```bash +# Step-by-step commands for local deployment +# For example: +# docker-compose up -d +# kubectl apply -f manifests/ +``` + +### Cloud Deployment + +```bash +# Commands for cloud deployment +# Include any cloud-specific setup +``` + +### Verification + +```bash +# Commands to verify deployment worked +# How to check if services are running +# Example health check endpoints +``` + +## Testing Instructions + +### Unit Tests + +```bash +# Commands to run unit tests +# For example: +# go test ./... +# npm test +``` + +### Integration Tests + +```bash +# Commands to run integration tests +# Any setup required for integration tests +``` + +### End-to-End Tests + +```bash +# Commands to run e2e tests +# How to set up test environment +``` + +## Usage Examples + +### Basic Usage + +```bash +# Examples of how to use the application +# Common commands or API calls +# Sample data or test scenarios +``` + +### Advanced Features + +```bash +# Examples showcasing advanced functionality +``` + +--- + +## Presentation Video + +**YouTube Link**: [Insert your YouTube link here] + +**Duration**: [X minutes Y seconds] + +**Video Includes**: + +- [ ] Project overview and architecture +- [ ] Live demonstration of key features +- [ ] Code walkthrough +- [ ] Build and deployment showcase + +## Troubleshooting + +### Common Issues + +#### Issue 1: [Common problem] + +**Symptoms**: [What the user sees] +**Solution**: [Step-by-step fix] + +#### Issue 2: [Another common problem] + +**Symptoms**: [What the user sees] +**Solution**: [Step-by-step fix] + +### Debug Commands + +```bash +# Useful commands for debugging +# Log viewing commands +# Service status checks +``` + +--- + +## Self-Assessment Table + +> Be honest and detailed in your assessments. +> This information is used for individual grading. +> Link to the specific commit on GitHub for each contribution. + +| Task/Component | Assigned To | Status | Time Spent | Difficulty | Notes | +| ------------------------------------------------------------------- | ----------- | ------------- | ---------- | ---------- | ----------- | +| Project Setup & Repository | [Name] | ✅ Complete | [X hours] | Medium | [Any notes] | +| [Design Document](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Easy | [Any notes] | +| [Backend API Development](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Hard | [Any notes] | +| [Database Setup & Models](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Medium | [Any notes] | +| [Frontend Development](https://github.com/dat515-2025/group-name) | [Name] | 🔄 In Progress | [X hours] | Medium | [Any notes] | +| [Docker Configuration](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Easy | [Any notes] | +| [Cloud Deployment](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Hard | [Any notes] | +| [Testing Implementation](https://github.com/dat515-2025/group-name) | [Name] | ⏳ Pending | [X hours] | Medium | [Any notes] | +| [Documentation](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Easy | [Any notes] | +| [Presentation Video](https://github.com/dat515-2025/group-name) | [Name] | ✅ Complete | [X hours] | Medium | [Any notes] | + +**Legend**: ✅ Complete | 🔄 In Progress | ⏳ Pending | ❌ Not Started + +## Hour Sheet + +> Link to the specific commit on GitHub for each contribution. + +### [Team Member 1 Name] + +| Date | Activity | Hours | Description | +| --------- | ------------------- | ---------- | ----------------------------------- | +| [Date] | Initial Setup | [X.X] | Repository setup, project structure | +| [Date] | Backend Development | [X.X] | Implemented user authentication | +| [Date] | Testing | [X.X] | Unit tests for API endpoints | +| [Date] | Documentation | [X.X] | Updated README and design doc | +| **Total** | | **[XX.X]** | | + +### [Team Member 2 Name] + +| Date | Activity | Hours | Description | +| --------- | -------------------- | ---------- | ----------------------------------------- | +| [Date] | Frontend Development | [X.X] | Created user interface mockups | +| [Date] | Integration | [X.X] | Connected frontend to backend API | +| [Date] | Deployment | [X.X] | Docker configuration and cloud deployment | +| [Date] | Testing | [X.X] | End-to-end testing | +| **Total** | | **[XX.X]** | | + +### [Team Member 3 Name] (if applicable) + +| Date | Activity | Hours | Description | +| --------- | ------------------------ | ---------- | -------------------------------- | +| [Date] | Database Design | [X.X] | Schema design and implementation | +| [Date] | Cloud Configuration | [X.X] | AWS/GCP setup and configuration | +| [Date] | Performance Optimization | [X.X] | Caching and query optimization | +| [Date] | Monitoring | [X.X] | Logging and monitoring setup | +| **Total** | | **[XX.X]** | | + +### Group Total: [XXX.X] hours + +--- + +## Final Reflection + +### What We Learned + +[Reflect on the key technical and collaboration skills learned during this project] + +### Challenges Faced + +[Describe the main challenges and how you overcame them] + +### If We Did This Again + +[What would you do differently? What worked well that you'd keep?] + +### Individual Growth + +#### [Team Member 1 Name] + +[Personal reflection on growth, challenges, and learning] + +#### [Team Member 2 Name] + +[Personal reflection on growth, challenges, and learning] + +#### [Team Member 3 Name] (if applicable) + +[Personal reflection on growth, challenges, and learning] + +--- + +**Report Completion Date**: [Date] +**Last Updated**: [Date] \ No newline at end of file