This is the README file for the NutriSmart App. It provides information about the project, how to get to it, and any other relevant details.
Welcome to nutriSmart, the innovative app designed to revolutionize your meal planning and nutritional tracking. Powered by Edamam's robust APIs, nutriSmart offers a comprehensive suite of tools to cater to your dietary needs and culinary curiosities.
- Discover Recipes: Explore a vast collection of recipes with our easy-to-use search feature. Just ype in the ingredients you have at hand, nutriSmart has you covered.
- Nutritional Information: Each recipe comes with detailed nutritional information. Stay informed about what you eat with data on calories, macronutrients, vitamins, and more.
- Analyze Custom Ingredients: Curious about the nutritional value of your home-cooked meals? Enter your ingredients, and our app will provide a comprehensive breakdown of the meal's nutritional content.
- Make Healthier Choices: Use this feature to tweak your recipes for better health. Substitute ingredients and see how it impacts the overall nutritional value of your dish.
- Personalized Cookbook: Easily save your favourite recipes for quick access. Whether it's a family classic or a new find, keep all your beloved recipes at your fingertips.
- Customize Your Collection: Organize your saved recipes into categories, making meal planning and grocery shopping a breeze.
No installation is required, you can access the live URL here: https://jennysiu.github.io/nutriSmartApp/
To view the code files, you can Git Clone by following the instructions below:
- Clone the repository:
git clone [https://github.com/jennysiu/nutriSmartApp] - Navigate to the project directory:
cd nutriSmartApp - Open the relevant code files.
No installation is required, you can access the live URL here: https://jennysiu.github.io/nutriSmartApp/
Once the webpage link is opened, it should look something like this:
- JavaScript
- jQuery
- HTML5
- CSS3
- Bootstrap
- The application primarily uses JavaScript for its functionality.
- Fetch API is employed to make requests to the Edamam APIs.
- Edamam's Recipe Search API
- Edamam's Nutritional Analysis API
- Local storage is used to store recent search data.
- Bootstrap is utilized for styling and layout purposes.
-
Will Mowlam as my contributing teamate.
-
The nutritional card table inspired by CodePen: [https://codepen.io/chriscoyier/pen/ApavyZ]
-
Background image from Unsplash. Creator's name Hermes Rivera: [https://unsplash.com/photos/vegetable-dish-in-white-ceramic-bowl-Ww8eQWjMJWk]
-
README template inspired by ChatGPT, an AI language model developed by OpenAI. (Note: portions of this README were generated with assistance from ChatGPT.)
MIT License
Copyright (c) [2024] [Jenny Siu]
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Feel free to reach out to me if you have any questions or feedback.