Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anagarango/chefwilly
https://github.com/anagarango/chefwilly
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/anagarango/chefwilly
- Owner: anagarango
- Created: 2024-03-21T01:01:20.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-04-08T06:18:57.000Z (9 months ago)
- Last Synced: 2024-04-09T03:48:43.736Z (9 months ago)
- Language: TypeScript
- Homepage: https://chefwilly.vercel.app
- Size: 2.84 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chef Willy
This project is designed to assist users (mostly for my brother) in finding recipes based on the ingredients they have on hand. Whether you're looking to whip up a quick meal or get creative with what's in your pantry, ChefWilly has you covered.
### Recipe Search
Search for recipes based on the ingredients added. The search results are sorted by recipes that require the fewest additional ingredients first, making it easier to find recipes with what you have on hand.
### Recipe Details
View detailed information about each recipe, including ingredients, cooking instructions, preparation time, and serving sizes. Nutritional icons are included showing what diets these recipes fall into.
### Filtering Options
Refine recipe search results based on various criteria such as cuisine type, dietary restrictions, or meal types.
### Ingredient Storage
Once signed in, users can store their commonly used ingredients. The app provides a database with autocomplete suggestions for users to update/delete their stored ingredients as needed.
### Cookbook Storage
Save your favorite recipes to your personalized cookbook for easy access later.
### Secure Authentication
Users can create accounts and sign in securely to manage their saved recipes and stored ingredients, ensuring personalization and data persistence across sessions.
## Getting Started
To get started with Recipe Generator, follow these steps:
```bash
git clone https://github.com/anagarango/ChefWilly.git
cd ChefWilly
```
Set up the database and configure authentication according to the provided instructions:
- Create a .env.local file with these environmental variables:
```js
NEXT_PUBLIC_API_KEY=
MYSQLPORT=
MYSQLDATABASE=
MYSQLPASSWORD=
MYSQLUSER=
MYSQLHOST=
```
- [Spoonacular API](https://spoonacular.com/food-api), sign up and paste the API key to NEXT_PUBLIC_API_KEY
- Add your credentials of your MySQL database, set up a database and add tables found under: src/app/api/DB.sql;
Start the server by running npm start.
```bash
npm install
npm run dev
```
## Technologies Used
- NextJS
- TypeScript
- Chakra-UI
- Axios
- MySQL
- [Free MySQL Hosting](https://www.freemysqlhosting.net)
- [Spoonacular API](https://spoonacular.com/food-api)