Skip to content

why-a-en/bite-byte

Repository files navigation

Bite Byte Documentation

Project documentation for the Bite Byte QR code food ordering platform.

Files

File Chapter Description
00-abstract-and-acknowledgement.md Abstract + Acknowledgement Project summary and acknowledgement template
01-introduction.md Chapter 1 Background, SWOT analysis, scope, aims & objectives
02-similar-product-comparison.md Chapter 2 Functional and non-functional comparison with Square Online and Mr Yum
03-literature-review.md Chapter 3 Agile/Scrum, TypeScript vs Python, PostgreSQL vs MongoDB, legal/ethical issues
04-system-requirements-and-architecture.md Chapter 4 Functional/non-functional requirements, MoSCoW, sprint plan, risks, diagrams
05-development-and-testing.md Chapter 5 Sprint-by-sprint development, screen designs, test plans (26/26 passing)
06-deployment.md Chapter 6 Vercel + Railway deployment architecture and process
07-evaluation-and-conclusion.md Chapter 7 Evaluation against aims, personal reflection, future work, limitations
08-references.md References Harvard-style reference list
09-appendix.md Appendix A-E Project proposal, sprint backlog, user stories, wireframe/test placeholders
FULL-DOCUMENT.md All Combined single file for .docx conversion

Placeholders to fill in

Screenshots

Search for [Screenshot placeholder: — add actual screenshots of:

  • App screens (login, dashboard, menu builder, ordering, analytics)
  • Competitor screenshots (Square Online, Mr Yum)
  • Deployment dashboards (Vercel, Railway)
  • Test execution evidence

Diagrams

Search for [Diagram placeholder: — create and insert:

  • Use case diagrams (Chapters 4 and 5, per sprint)
  • Class diagrams (Chapters 4 and 5, per sprint)
  • Deployment architecture diagram (Chapter 6)
  • Deployment pipeline diagram (Chapter 6)

Personal sections

In 07-evaluation-and-conclusion.md, sections 7.3.1-7.3.3 have [Personalise...] markers to write in your own voice.

Acknowledgement

In 00-abstract-and-acknowledgement.md, replace [Supervisor Name], [University Name], [Your Name], and [Date].

Citations

A few references are marked [Citation needed] or [verify] — double-check those before submission.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages