Skip to content

Commit

Permalink
added inital stuff into reeadme
Browse files Browse the repository at this point in the history
  • Loading branch information
Hitesh Patel authored and Hitesh Patel committed Jan 3, 2024
1 parent 66527b3 commit be83458
Showing 1 changed file with 63 additions and 0 deletions.
63 changes: 63 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,65 @@
# DishDiscovery
Navigate Flavor Frontiers! A fun app to get recipies and tutorial videos


## Description
---
With your team, you'll conceive and execute a design that solves a real-world problem by integrating data received from multiple server-side API requests. You will also continue to learn about agile development methodologies to help you work collaboratively. You will implement feature and bug fixes using git branch workflow and pull requests.
You will write your own user stories and acceptance criteria in GitHub Issues to help your team stay on track with the project. Using GitHub Project as a means to track the status of your project tasks will help you understand the benefits of Kanban boards.

## Learning Objectives
----
<li>
Speak technically about a feature you implemented in your project
<li>
Explain and execute git branching workflow in a collaborative project
<li>
Resolve merge conflicts
<li>
Explain agile software development
<li>
Design, build, and deploy a client-side web application using GitHub Pages
<li>
Prepare a professional presentation and repository README for your project
<br>
<br>

## Tools
----
The following tools are to be used in this project:
<ol>
<li> HTML and CSS
<li> Bootstrap
<li> Take input from a user and respond from that input
<li> Modals
<li> Client-side storage
<li> Respondive. When the web-page is resized the site responds accordingly
<li> the two server side API we used are Youtube AI and TheMealDB API
</ol>

## Methodology
----
This application is a single page we-application. It will ask the user for an input of a recipe of their choice. Once they click search it will populate a recipe and a youtube video linked to the recipe they have found. The user will also have the ability to add their recipe's to favourites, just so they can do a quick view on the recipe when needed.
<br>
<br>
Below is our approach to this task:
<ol>
<li> We split the task up so that each group memeber is assigned a task.
<li>
<li>
<li>
<li>
<li>
<li>
<li>
<li>
</ol>

## Conclusion

## Future Improvements

As a group we worked really well together. No issues were faced. However, there somethings we could improve on:

<ol>
<li> When merging the branchs on github we should've kept certain things constant. For example, the API keys and URL. By not keeping this constant it led to many conflicts and in the end we had to manually add our work to the main branch which is not efficient.

0 comments on commit be83458

Please sign in to comment.