Welcome to our Recipe App project! This repository is the collaborative effort of our agile team working on building an innovative recipe application using Next.js and various other libraries.
Meet the amazing chefs behind the scenes:
- Product Owner: David Robertson
- Product Manager: Renzo Van Wyk
- Scrum Master: Chad Bosch
- Agile Members:
- Keorapetse Magano
- Lulu Mosobe
- Mothusi Mathuloe
- Mpho Makgwe
- Olga Maseng
- Oratile Mokgoatlheng
- Otshepeng Setuke
- Refilwe Nqatyelwa
Our Recipe App comes with a variety of features to enhance the user experience:
- Displaying recipe cards with cooking time, prep time, tags, categories, and more.
- Filtering recipes by steps, prep time, tags, and categories.
- Search functionality with highlighted title matches.
- Adding recipes to favorites.
- Editing recipe descriptions and instructions.
- Theme toggling.
- Pagination for navigating through recipe pages.
- Previewing recipes.
- Viewing detailed recipe information.
Our secret recipe includes the use of these powerful libraries:
- @emotion/react@11.11.1
- @fortawesome/fontawesome-free@6.4.2
- @heroicons/react@2.0.18
- @mui/icons-material@5.14.16
- @mui/material@5.14.18
- @next/eslint-plugin-next@14.0.1
- @types/node@20.8.3
- @types/react@18.2.25
- autoprefixer@10.4.16
- cookies-next@4.1.0
- eslint-config-airbnb@19.0.4
- eslint-config-prettier@9.0.0
- eslint-plugin-import@2.29.0
- eslint-plugin-jsx-a11y@6.8.0
- eslint-plugin-next@0.0.0
- eslint-plugin-react-hooks@4.6.0
- eslint-plugin-react@7.33.2
- eslint@8.54.0
- heroicons@2.0.18
- js-cookie@3.0.5
- mongodb@6.1.0
- next-themes@0.2.1
- next@13.5.4
- postcss-import@15.1.0
- react-dom@18.2.0
- react-highlight-words@0.20.0
- react-icons@4.12.0
- react-multi-carousel@2.8.4
- react-responsive-carousel@3.2.23
- react-select@5.7.7
- react@18.2.0
- styled-components@6.1.1
- swr@2.2.4
- tailwindcss@3.3.3
- typescript@5.2.2
- uuid@9.0.1
To get started with the Recipe App locally, follow these steps:
- Clone the repository:
git clone <repository-url> - Install dependencies:
npm install - Start the development server:
npm run dev
Our agile development process follows the Scrum methodology, with regular sprint planning, daily stand-ups, and sprint reviews. The Scrum Master, Chad Bosch, is responsible for ensuring the team's adherence to Scrum principles and facilitating smooth communication.
At the beginning of each sprint, the team conducts a sprint planning session. During this meeting, the Product Manager, Chad Bosch, presents the prioritized user stories and features for the upcoming sprint. The team collaboratively estimates the effort required for each task and commits to a set of deliverables for the sprint.
We conduct daily stand-up meetings to keep everyone in the loop and address any challenges. Each team member provides a brief update on their progress, highlights any impediments, and communicates their plan for the day. This short, focused meeting ensures that everyone is on the same page and can quickly address any blockers.
At the end of each sprint, the team holds a sprint review to showcase the completed worrk. This session allows for feedback and discussions on the features delivered during the sprint.
We use a branching strategy to manage code changes efficiently. When contributing to the project, follow these steps:
For contributing to the project, follow these steps:
- Create a new branch for your feature or bug fix:
git checkout -b feature/your-feature - Fetch the latest changes from the main branch:
git fetch origin main - Merge the latest changes into your branch:
git merge origin/main - Implement your changes and test thoroughly.
- Push your branch to the repository:
git push origin feature/your-feature - Submit a pull request for review.
We welcome contributions from all team members. If you have ideas for improvements or new features, please follow our Contribution Guidelines.
We would like to express our gratitude to the entire team for their hard work and dedication to making this Recipe App a success. Special thanks to our Product Manager, Renzo Van Wyk, and our Scrum Master, Chad Bosch, for their leadership and guidance. Together, we are creating a delightful experience for our users!
Happy coding! 🚀