-
Notifications
You must be signed in to change notification settings - Fork 0
Add comprehensive README.md documentation #103
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Co-authored-by: Clashsoft <4145923+Clashsoft@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds comprehensive root-level README.md documentation for the Coffee Counter application, covering setup instructions, development workflows, architecture overview, and deployment procedures. The repository previously lacked centralized documentation at the root level.
Key Changes
- Added complete README.md with quick start guide using Docker Compose
- Documented local development setup for both NestJS backend and Angular frontend
- Included Kubernetes deployment instructions with Helm chart reference
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ``` | ||
|
|
||
| The Helm chart includes: | ||
| - MongoDB deployment with persistent storage |
Copilot
AI
Nov 18, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation states "MongoDB deployment with persistent storage" but the Helm chart templates do not include a MongoDB deployment. The chart only references an existing MongoDB instance via secrets. Consider either:
- Updating the documentation to clarify that MongoDB should be deployed separately or an existing MongoDB instance should be used
- Adding a MongoDB deployment to the Helm chart templates
| - MongoDB deployment with persistent storage | |
| - Integration with an existing MongoDB instance (MongoDB must be deployed separately; connection details are provided via secrets) |
| ### Environment Configuration | ||
|
|
||
| Edit `docker-compose.yaml` to customize: | ||
| - `COFFEE_PRICE`: Price per coffee (default: 0.4) |
Copilot
AI
Nov 18, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The COFFEE_PRICE environment variable is documented here but is not actually defined in the docker-compose.yaml file. The backend service in docker-compose.yaml only includes MONGO_URI and COFFEE_API_KEY. Either add COFFEE_PRICE to the backend service environment variables in docker-compose.yaml, or remove this line from the documentation since it defaults to 0.4 in the backend code.
| - `COFFEE_PRICE`: Price per coffee (default: 0.4) |
Repository lacked root-level documentation. Added README.md covering setup, development, and deployment.
Content
Key Details
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.