Skip to content

Commit c712965

Browse files
committed
sprint 4 docs
1 parent 2fabe57 commit c712965

8 files changed

Lines changed: 193 additions & 1458 deletions

File tree

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ jspm_packages/
6565

6666
# Testing
6767
__tests__/
68-
*.test.js
68+
# *.test.js
6969
*.spec.js
7070

7171
# Temporary folders

doc/Sprint 3 - Microsofties.rtf

Lines changed: 0 additions & 1457 deletions
This file was deleted.

doc/sprint2/schedule.pdf

-1.08 MB
Binary file not shown.

doc/sprint3/schedule.pdf

-1.14 MB
Binary file not shown.

doc/sprint4/RPM.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Release Plan: Glow by Microsofties
2+
3+
## Release Name
4+
**Glow by Microsofties**
5+
6+
---
7+
8+
## Release Objectives
9+
Deliver a stable, user-friendly version of the GLOW application that includes historical temperature visualization, improved UI/UX, pipelines for deployment, and bug fixes to ensure it is ready for public release.
10+
11+
---
12+
13+
## Specific Goals
14+
- **Historical Graph**
15+
Implement a graph component to display historical water temperature trends for each beach/location.
16+
- **Docker Containerization**
17+
Containerize the application using Docker for consistent environment deployment.
18+
- **CI/CD Pipelines**
19+
Configure automated testing, build, and deployment pipelines to streamline development workflow.
20+
- **UI/UX Refinement**
21+
Refine color schemes, layout responsiveness, and overall design for better user experience.
22+
- **User Dashboard**
23+
Add a dashboard for users to view saved points, personalized data, and quick navigation.
24+
- **Bug Resolution**
25+
Identify and resolve existing functional or UI bugs affecting the core features.
26+
- **Production Readiness**
27+
Finalize deployment configuration to launch a working production build.
28+
29+
---
30+
31+
## Metrics for Measurement
32+
33+
### Historical Graph
34+
- Graph shows correct historical temperature data for most beaches.
35+
- Tested by comparing with real API data.
36+
37+
### Docker Pipeline
38+
- App runs fully with one `docker-compose up` command.
39+
- Tested on a fresh machine to confirm setup works.
40+
41+
### CI/CD Pipeline
42+
- Code changes automatically build and deploy within 5 minutes.
43+
- Confirmed by checking test deployment after merging to `main`.
44+
45+
### UI Improvements
46+
- Team feedback shows better look and easier navigation (aim: 80%+ approval).
47+
- Fewer UI complaints during testing.
48+
49+
### User Dashboard
50+
- Dashboard loads quickly and shows correct saved data.
51+
- Tested with multiple user accounts.
52+
53+
### Bug Fixes (Metrics)
54+
- All major bugs fixed, and no new high-priority bugs appear in testing.
55+
- Confirmed by checking bug tracker after fixes.
56+
57+
### Deployment Readiness
58+
- Working production build available online without errors.
59+
- Tested with full walkthrough of main features.
60+
61+
---
62+
63+
## Release Scope
64+
65+
### Included Features
66+
- **Historical Temperature Graph**
67+
- Adds a graph to show past water temperatures for each location.
68+
- Purpose: Helps users see trends and plan visits better.
69+
- **User Dashboard**
70+
- New dashboard showing saved points and personalized data.
71+
- Purpose: Improves usability and user experience.
72+
73+
### Excluded Features
74+
- **Time Range Filters**
75+
Not included due to low priority and limited sprint time. Will be considered in future releases to allow users to view temperature data over custom periods.
76+
- **Archive & Download Data**
77+
Deferred because of time constraints and focus on core interactive features. Will be added later to allow exporting historical data for offline use or research purposes.
78+
79+
### Bug Fixes (Scope)
80+
- **Theme Switching Problems**
81+
Fixed bugs when toggling between light/dark mode.
82+
83+
---
84+
85+
## Non-Functional Requirements
86+
- **Performance**
87+
- Map loads in under 5 seconds on broadband connections.
88+
- Graph renders historical data in under 2 seconds.
89+
- **Security**
90+
- All API requests secured with HTTPS and environment variables hidden.
91+
- **Usability**
92+
- Mobile-friendly interface with responsive layout for phones and tablets.
93+
- Clear color contrast for temperature markers and gradients.
94+
95+
---
96+
97+
## Dependencies & Limitations
98+
- **Dependencies**
99+
- Relies on external water temperature API for live and historical data.
100+
- Map rendering depends on Leaflet.
101+
- **Limitations**
102+
- Historical data may be limited or incomplete for certain beaches.
103+
- Requires internet connection; no offline functionality.
104+
- CI/CD pipeline limited to GitHub Actions.

doc/sprint4/burndown.pdf

264 KB
Binary file not shown.

doc/sprint4/schedule.pdf

1.1 MB
Binary file not shown.

doc/sprint4/sprint-04.review.md

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# Iteration 4 - Review & Retrospect
2+
**Project:** GLOW by Microsofties
3+
4+
---
5+
6+
## Meeting Details
7+
8+
- **When:** August 2, 2024
9+
- **Where:** Our House
10+
11+
---
12+
13+
## Process – Reflection
14+
15+
In this sprint we reflected on how the team worked together, what worked well, and what could be improved for smoother collaboration in future iterations.
16+
17+
---
18+
19+
### Decisions that turned out well
20+
21+
1. **Starting the sprint earlier**
22+
Beginning work ahead of schedule helped us identify blockers early and distribute workload more evenly.
23+
24+
2. **Aligning on priorities before starting work**
25+
Defining key tasks early ensured everyone focused on high-impact features first.
26+
27+
3. **Meeting more regularly**
28+
Frequent check-ins improved communication, allowed faster feedback, and sped up decision-making during UI/UX refinements.
29+
30+
---
31+
32+
### Decisions that did not turn out as well as we hoped
33+
34+
1. **Flexible deadlines for tasks**
35+
While flexible timelines reduced stress for individuals, it caused uneven progress across features, leading to integration delays and last-minute coordination.
36+
37+
---
38+
39+
### Planned changes
40+
41+
1. **Set clearer deadlines and checkpoints**
42+
Establish stricter internal deadlines and mid-sprint check-ins to prevent last-minute rushes.
43+
44+
2. **Improve estimation for unexpected work**
45+
Build a small buffer into sprint planning to manage surprise tasks without affecting critical features.
46+
47+
---
48+
49+
## Product – Review
50+
51+
### Goals and/or tasks completed
52+
53+
- **Historical Temperature Graph**
54+
Implemented and tested using real API data.
55+
56+
- **User Dashboard**
57+
Completed for displaying saved points and personalized data.
58+
59+
- **Docker Containerization**
60+
Application now runs fully using `docker-compose up`.
61+
62+
- **CI/CD Pipelines**
63+
Automated builds and deployments within 5 minutes confirmed after merging to `main`.
64+
65+
- **UI/UX Improvements**
66+
Enhanced color contrast, responsive design, and navigation; positive team feedback received.
67+
68+
- **Bug Fixes**
69+
Fixed theme switching, font consistency, and historical map display issues.
70+
71+
---
72+
73+
### Goals and/or tasks not completed
74+
75+
- **Time Range Filters**
76+
Deferred due to low priority and limited sprint time.
77+
78+
- **Archive & Download Data**
79+
Postponed to focus on core interactive features for this release.
80+
81+
---
82+
83+
## Meeting Highlights
84+
85+
- Continue starting early and aligning on priorities to maintain smooth progress.
86+
- Add time buffers for unforeseen bugs or last-minute tasks to avoid integration stress.
87+
- Refine CI/CD pipelines further to catch UI regressions early.
88+
- Next iteration will prioritize postponed features (e.g., time range filters, data export) while maintaining stability of core features.

0 commit comments

Comments
 (0)