The Recipe Planner

A simple application for choosing dinner and creating grocery lists.
Explore the docs »

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

The inception of this project was driven by a challenge posed by our professor to design an application capable of addressing three primary functionalities: generating random recipes, maintaining a comprehensive grocery list, and seamlessly converting quantities between Metric and Imperial units. Recognizing the practicality and everyday relevance of such an application, my teammate Peter and I embarked on a collaborative journey to create what we now proudly call The Recipe Planner.

Our goal was to develop a tool that not only meets the technical requirements of the assignment but also addresses real-world challenges faced by consumers. From simplifying meal planning to aiding in grocery shopping and accommodating different measurement systems, The Recipe Planner is designed to be a versatile and user-friendly solution for anyone looking to streamline their cooking experience.

(back to top)

Built With

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To begin working with this repository, there are a few preliminary steps that need to be completed to set up the project properly. The following instructions will guide you through the necessary process to ensure a seamless experience. Whether you're setting up the project locally for development or preparing it for deployment, these steps will help you get started efficiently and without issues.

Ensure Your Environment is Ready: Before diving into the repository, verify that your development environment meets the prerequisites. This includes having the necessary software, tools, and dependencies installed on your system.

Clone the Repository: Start by cloning the repository to your local machine to gain access to all the project files.

Install Required Dependencies: Install the necessary packages and libraries to ensure all features of the project function as intended.

Configure Project-Specific Settings: Make any required configurations, such as setting up API keys, modifying environment variables, or adjusting file paths.

By following these steps, you will be prepared to work with the repository and contribute effectively. Detailed instructions for each step are provided below to guide you through the setup process.

Prerequisites

• npm

  npm install npm@latest

Installation

1. Clone the repo

   git clone https://github.com/nathangreen1632/recipe-planner

2. Install NPM packages

   npm install

3. Enter your API in config.js

   const API_KEY = 'ENTER YOUR API';

4. Change git remote url to avoid accidental pushes to base project

   git remote set-url origin github_username/repo_name
   git remote -v # confirm the changes

Get Running

When the repo has been cloned and opened in your IDE, open Terminal and run, which will run the build command one time and process your CSS.

  npm run build-css

This will setup npm to watch your source app.css file for changes. Everytime you make a change, build-css will run and process your CSS changes. Use ctrl+C to cancel the watch-css job in terminal.

  npm run watch-css

(back to top)

Usage

The following links provide screenshots of the various functionality you will find throughout this application:

• Add a new recipe
• Randomly select a recipe from your existing recipes
• Generate a grocery list from a single recipe
• Plan your meals for the week
• Add a one-off ingredient to your grocery list
• Adjust serving sizes
• Convert from imperial to metric and vice-versa

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Peter Hintze - @coder-guy-peter - [email protected]

Nathan Green - @nathangreen1632 - [email protected]

Project Link: https://github.com/nathangreen1632/recipe-planner

(back to top)

Acknowledgments

• Latisha McNeel for supporting us and providing us with a Tailwind-html-template
• Jason Xie for helping us work through our JS logic

(back to top)