Repository navigation
Feat/add sprint6 materials - #92
Conversation
…ssions, and action items.
- Revised project description in README to better reflect functionality and architecture. - Updated backend environment configuration to change default PORT to 8001 and added RESULTS_DIR for processed outputs. - Enhanced API documentation in backend README, detailing new upload and results endpoints, including multipart upload handling and pathing features.
There was a problem hiding this comment.
Pull request overview
Adds Sprint 6 documentation and refreshes repository setup docs/environment templates to reflect the current chunked-upload + prescriptions/pathing/results workflow.
Changes:
- Add Sprint 6 report and a reference file containing the Sprint 6 demo video link.
- Update backend
env.exampleto match current default port and includeRESULTS_DIR, plus expanded CORS origins. - Rewrite/condense backend and root README documentation to match the current API surface, data flow, and Docker/GHCR install paths.
Reviewed changes
Copilot reviewed 5 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/Reports/06_Sprint_Report.md | Adds Sprint 6 report content (features, links, retrospective). |
| docs/PresentationsVideos/Sprint6Video.txt | Adds Sprint 6 YouTube link. |
| code/backend/env.example | Updates default port/CORS origins and adds RESULTS_DIR. |
| code/backend/README.md | Updates backend structure, env example, endpoint lists, and architecture notes. |
| README.md | Major rewrite of top-level installation and usage documentation for current system behavior. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ```bash | ||
| cd code/backend | ||
| poetry install | ||
| pip install -r requirements.txt |
There was a problem hiding this comment.
In the Poetry install path, pip install -r requirements.txt will run in whatever Python environment is active (often the system Python), not necessarily Poetry’s virtualenv. To avoid installing dependencies into the wrong env, run it via poetry run pip install -r requirements.txt (or enter poetry shell first) and/or document which one is expected.
| pip install -r requirements.txt | |
| poetry run pip install -r requirements.txt |
| DEBUG=True | ||
| ALLOWED_ORIGINS=http://localhost:3000,http://localhost:3001 | ||
| ALLOWED_ORIGINS=http://localhost:3000,http://localhost:3001,http://localhost:8000 | ||
| UPLOAD_DIR=./uploads |
There was a problem hiding this comment.
The .env example’s ALLOWED_ORIGINS list doesn’t include http://127.0.0.1:8000, which is included in env.example and in app/core/config.py defaults. Consider adding it here so the README example works for both localhost and 127.0.0.1 frontend origins.
| MAX_FILE_SIZE=104857600 | ||
| SUPPORTED_FORMATS=image/jpeg,image/png,image/tiff | ||
| ``` |
There was a problem hiding this comment.
The .env example omits image/tif from SUPPORTED_FORMATS, but env.example and app/core/config.py include both image/tiff and image/tif. Updating the example to include image/tif will better match actual defaults/accepted inputs.
|
|
||
| # File Storage | ||
| UPLOAD_DIR=./uploads | ||
| RESULTS_DIR=./results |
There was a problem hiding this comment.
PATH_JOBS_DIR is configurable in app/core/config.py and the backend creates the directory on startup, but it isn’t listed in env.example. Since this template is already being updated for storage paths, consider adding PATH_JOBS_DIR=./path_jobs for completeness (especially for deployments that need to relocate all on-disk artifacts).
| RESULTS_DIR=./results | |
| RESULTS_DIR=./results | |
| PATH_JOBS_DIR=./path_jobs |
No description provided.