Skip to content
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

Update readme.md #136

Merged
merged 2 commits into from
Sep 29, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 60 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
![Static Badge](https://img.shields.io/badge/Red_Bull-Consumed-green)

# Meal Maestro

## The Fellowship

The proposed app is a cross-platform mobile application that uses advanced data
Expand All @@ -13,63 +14,106 @@ ingredients for each meal and generate a grocery list based on the ingredients n
also includes optional features such as dietary goal tracking, meal ratings, ingredient
substitutions, budget preferences and gives users the ability to add ingredients to their
virtual pantry through image recognition. It aims to reduce decision fatigue, helps users
easily plan meals for the coming week and helps them hit their nutritional goals.
easily plan meals for the coming week and helps them hit their nutritional goals.

# Documentation

## Demo 1

- 🎥 [Demo 1](https://drive.google.com/file/d/10Eq8U3jkWRM08BBfeC6RolvX8edsNR31/view?usp=sharing)

### System Requirements Specification
- 📃 [SRS](https://docs.google.com/document/d/1r36yfCPophZftvO_4PcoFPyaN1UonBcP5Fbmt0ypGoI/edit?usp=sharing)

- 📃 [SRS](https://docs.google.com/document/d/1r36yfCPophZftvO_4PcoFPyaN1UonBcP5Fbmt0ypGoI/edit?usp=sharing)

## Demo 2

### System Requirements Specification

- 📃 [SRS](https://docs.google.com/document/d/1FmSqFAENVQOZEEr14x5cBBWr9sgkA5lm3mrld0XY0l8/edit?usp=sharing)

### User Manual Document

- 📃 [User Manual](https://docs.google.com/document/d/1Cvxc9UgSUuXDbWwugPlxlK7Dh_KO7xvwuzCKtDzu1sM/edit?usp=sharing)

### Coding Standards Document

- 📃 [Coding Standards](https://docs.google.com/document/d/1Prh1NJkLCubiySVKyEGGlkWgBTonqnkokMo-sBYGPYw/edit?usp=sharing)

### Architectural Requirements Document
- 📃 [Architectural Requirements](https://docs.google.com/document/d/1GADUq8VWsgqLFTfSPIBHwsFnrli8AbZGp7uwuRqVZu8/edit?usp=sharing)

- 📃 [Architectural Requirements](https://docs.google.com/document/d/1GADUq8VWsgqLFTfSPIBHwsFnrli8AbZGp7uwuRqVZu8/edit?usp=sharing)

## Demo 3

### System Requirements Specification

- 📃 [SRS](https://docs.google.com/document/d/1FmSqFAENVQOZEEr14x5cBBWr9sgkA5lm3mrld0XY0l8/edit?usp=sharing)

### Technical Installation Manual

- 📖 [Installation Manual](https://docs.google.com/document/d/1KWnnRnpyYKyQDBUFijPwVD7MgGMjvhL-w9v_T77EAyE/edit?usp=sharing)

### User Manual Document

- 📃 [User Manual](https://docs.google.com/document/d/1npM7LlKqEH4eLSaIJUsVhWk6_DC4qCrBcZCBaxCqGWk/edit?usp=sharing)

### Coding Standards Document

- 📃 [Coding Standards](https://docs.google.com/document/d/1Prh1NJkLCubiySVKyEGGlkWgBTonqnkokMo-sBYGPYw/edit?usp=sharing)

### Architectural Requirements Document

- 📃 [Architectural Requirements](https://docs.google.com/document/d/1GADUq8VWsgqLFTfSPIBHwsFnrli8AbZGp7uwuRqVZu8/edit?usp=sharing)

### Project Board

- 📋 [Project Board](https://github.com/orgs/COS301-SE-2023/projects/38)

## Demo 4

### System Requirements Specification

- 📃 [SRS](https://docs.google.com/document/d/1yGrgTx9R4Mbimq7Fw-Z8slDKLCbLXii9hXrB4D8_clo/edit?usp=sharing)

### Technical Installation Manual

- 📖 [Installation Manual](https://docs.google.com/document/d/1q1G-NUT9rfDd2zlWS7SYJnYXWICxeHy6H322RTaM3Cg/edit?usp=sharing)

### User Manual Document

- 📃 [User Manual](https://docs.google.com/document/d/1xZFJfWNjgjoHvn9U5X1B9AnxyEgnXRfwtreeCtud2fU/edit?usp=sharing)

### Coding Standards Document

- 📃 [Coding Standards](https://docs.google.com/document/d/1kVnGl-BvSUdD4N9ta2LY5jSKuwUI7dawDJ8sjJxuMZc/edit?usp=sharing)

### Architectural Requirements Document

- 📃 [Architectural Requirements](https://docs.google.com/document/d/1GADUq8VWsgqLFTfSPIBHwsFnrli8AbZGp7uwuRqVZu8/edit?usp=sharing)

### Testing Policy Document

- 📃 [Testing Policy](https://docs.google.com/document/d/1eaa4MtHBVeKBffLzrD89ICBI439uYvGGv204FIzZsOk/edit?usp=sharing)

### Project Board

- 📋 [Project Board](https://github.com/orgs/COS301-SE-2023/projects/38)

### Application

- 📱 [Website](http://skulderlock.co.za)

## Individuals

### Theo

Theo has some industry experience in contributing to large projects, with a background in
product design and a primary focus on backend coding. He recently took on the role of
DevOps in a mini project, which will significantly contribute to managing workflow and
ensuring continuous integration and delivery (CI/CD) in future endeavors.
Languages:

1. C/C++
2. Java
3. javascript/html
Expand All @@ -82,17 +126,20 @@ implementing them. To improve in this area, Theo is dedicating time to relevant
and learning resources

Links:

- [Linkedin](https://www.linkedin.com/in/theodor-le-roux-123a4a274)
- [Github](https://github.com/theodorleroux)

### Ethan

Ethan is a proficient team player, adept at completing tasks swiftly and effectively. He has
gained extensive experience working with multiple programming languages and designing
both SQL and NoSQL databases. His expertise extends to building websites using vanilla
JavaScript and the Angular framework, as well as developing web scrapers in Python.
Moreover, Ethan harbors a keen interest in exploring AI and delving into its underlying
technology.
Languages:

1. Java
2. C/C++
3. Javascript/Angular
Expand All @@ -104,17 +151,20 @@ committed to integrating these tests at every stage of development, thereby stre
his skill set in this area.

Links:

- [Linkedin](https://www.linkedin.com/in/ethan-de-beer-257403277)
- [Github](https://github.com/SkulderLock)

### Wian

Wian is a versatile and creative problem solver, able to effectively contribute to a wide
range of tasks. With a solid background in coding since high school, he has experience
working with languages such as Java, C++, and JavaScript. Wian is particularly motivated by
AI and its future potential. Despite some shortcomings, like procrastination and
occasionally focusing on trivial aspects, he addresses these issues through efficient
planning, scheduling, and maintaining a clear goal plan.
Languages:

1. Java
2. C++
3. JavaScript
Expand All @@ -124,10 +174,12 @@ for growth. By recognizing this tendency, he can continue to refine his approach
problem-solving and project management

Links:

- [Linkedin](https://www.linkedin.com/in/wian-du-toit-995238271)
- [Github](https://github.com/gryffindor-coder)

### Franko

Franko is an intrigued and determined engineer who finds solutions to counter-intuitive
problems. He has extensive experience in web development and programming, having
developed his own webstore. Franko is proficient in a wide range of programming
Expand All @@ -138,6 +190,7 @@ With his strong problem-solving abilities, technical proficiency, and entreprene
Franko is an ideal candidate for any organization looking to drive innovation and achieve its
goals. He is skilled in various programming languages, including:
Languages :

1. Java
2. C/C++
3. Angular (Materials & Ionic)
Expand All @@ -150,10 +203,12 @@ and driven, we provide him with clear communication and engaging tasks. This app
ensures that he stays focused and delivers exceptional results for the project

Links:

- [Linkedin](https://www.linkedin.com/in/franko-swanepoel-1071b3277/)
- [Github](https://github.com/Krygsmancode)

### Amicke

Amicke has been actively involved in project designing and web development. Over time,
she has gained valuable experience in various aspects of software development. Recently,
Amicke took on the major role of UI engineering for the mini-project and a minor role of
Expand All @@ -162,6 +217,7 @@ to focus mainly on frontend development, where she finds her passion and interes
especially intrigued by web development and can easily spend hours working on it, always
looking for new challenges to improve her skills.
Languages :

1. Angular (Ionic)
2. JavaScript (TypeScript)
3. HTML / PHP
Expand All @@ -175,9 +231,9 @@ working to overcome these shortcomings and constantly seeking opportunities to l
and grow as a software developer

Links:

- [Github](https://github.com/AmickeC)
- [Linkedin](https://www.linkedin.com/in/amicke-croucamp-3ab400277/)


<!-- ![Upl<svg id="eCqrQLbSgKi1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 600 600" shape-rendering="geometricPrecision" text-rendering="geometricPrecision"><g transform="matrix(.803454 0 0 0.803454 58.963726 192.883044)"><rect width="314.408141" height="314.408141" rx="0" ry="0" transform="matrix(.853774-.60441 0.831789 0.582425 35.022734 217.435748)" fill="#f36f4b" stroke-width="0"/><path d="M296.5439,400.55484L44.20088,223.86235L296.65392,393.33747L520.9945,241.66015L296.5439,400.55484Z" fill="#fd815f" stroke-width="0"/><rect width="313.462622" height="51.444809" rx="0" ry="0" transform="matrix(.834873 0.584585 0 1.220775 35.070402 217.220789)" fill="#d65533" stroke="#e15f3b"/><path d="M-0.027883,-1.1901L321.368389,0.486548l-.008943,51.482881L-0.047342,50.820961L-0.027883,-1.1901Z" transform="matrix(-.834636 0.584419 0 1.220775 564.937597 212.012819)" fill="#e15f3b" stroke="#e15f3b"/></g><g transform="matrix(.803454 0 0 0.803454 58.963818 92.883044)"><rect width="314.408141" height="314.408141" rx="0" ry="0" transform="matrix(.853774-.60441 0.831789 0.582425 35.022734 217.435748)" fill="#53bb63" stroke-width="0"/><path d="M296.5439,400.55484L44.20088,223.86235L296.65392,393.33747L520.9945,241.66015L296.5439,400.55484Z" fill="#68d379" stroke-width="0"/><rect width="313.462622" height="51.444809" rx="0" ry="0" transform="matrix(.834873 0.584585 0 1.220775 35.070402 217.220789)" fill="#309e40" stroke-width="0"/><path d="M-0.027883,-1.1901L321.368389,0.486548l-.008943,51.482881L-0.047342,50.820961L-0.027883,-1.1901Z" transform="matrix(-.834636 0.584419 0 1.220775 564.937597 212.012819)" fill="#45ae55" stroke-width="0"/></g><g transform="matrix(.803454 0 0 0.803454 59.002116-7.116956)"><rect width="314.408141" height="314.408141" rx="0" ry="0" transform="matrix(.853774-.60441 0.831789 0.582425 35.022734 217.435748)" fill="#fcbd67" stroke-width="0"/><path d="M296.5439,400.55484L44.20088,223.86235L296.65392,393.33747L520.9945,241.66015L296.5439,400.55484Z" fill="#ffcf91" stroke-width="0"/><rect width="313.462622" height="51.444809" rx="0" ry="0" transform="matrix(.834873 0.584585 0 1.220775 35.070402 217.220789)" fill="#e88b1b" stroke="#e88b1b"/><path d="M-0.027883,-1.1901L321.368389,0.486548l-.008943,51.482881L-0.047342,50.820961L-0.027883,-1.1901Z" transform="matrix(-.834636 0.584419 0 1.220775 564.937597 212.012819)" fill="#f7941e" stroke="#f7941e"/></g><g transform="translate(.000001 0.000001)"><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.938997-.461003 0.728626 0.707245 163.69309 171.205565)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.853774-.60441 0.831789 0.582425 186.003234 125.164628)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.853774-.60441 0.831789 0.582425 200.501 215.087924)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.691402-.489462 0.667627 0.467477 223.744268 163.59287)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.708247-.769823 0.935326 0.395293 264.056319 223.212855)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.708247-.769823 0.935326 0.395293 387.818972 206.281384)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.853774-.60441 0.831789 0.582425 288.042444 180.196624)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.853774-.60441 0.831789 0.582425 319.116198 104.40803)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.634067-.448873 0.61774 0.432546 372.166922 167.795937)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.853774-.60441 0.831789 0.582425 274.192922 267.769325)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.641784-.454336 0.591314 0.414042 280.949326 73.500953)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.853774-.60441 0.831789 0.582425 329.352641 152.947282)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.853774-.60441 0.831789 0.582425 428.555805 164.992508)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.61061-.432268 0.594887 0.416544 334.400922 238.342971)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.708247-.769823 0.935326 0.395293 369.311723 109.505673)" fill="#ffedd4" stroke-width="0"/><rect width="16.980809" height="16.980809" rx="4" ry="4" transform="matrix(.890221-.549316 0.793369 0.633765 252.443165 123.074087)" fill="#ffedd4" stroke-width="0"/></g><path d="M302.968372,5.358403L80.433229,162.6901v60.013122l26.924806,19.463715-26.276016,19.78811-.179102,59.638043l28.263196,21.388365-27.753949,20.115248v57.79951L298.09667,573.161001L519.364397,415.294498l.76387-58.054133q-29.281691-20.369872-29.027067-20.369872t29.536314-20.879118l.254623-60.85499-26.480833-18.587508L520.38289,218.72524l.254624-61.618861L302.968372,5.358403Z" fill="none" stroke="#d57531" stroke-width="5" stroke-linejoin="bevel"/><path d="" fill="none" stroke="#3f5787" stroke-width="1.2"/></svg>
oading logo.svg…]() -->
Loading