meal_planner/README.md
2020-02-04 15:10:44 +01:00

104 lines
2.3 KiB
Markdown

# Chef's Meal Planner
Free meal planner for cooks short on ideas! (like me …)
[v.0.1 Available Here!](https://chefs-meal-planner.onrender.com/)
## Features
- Random meal suggestion ✓
- Search by name: you're look for a recipe? Ours are easy to make and Yummy! ✓
- What's in the fridge ? Choose your main ingredient and get a meal suggestion
- Choose by category: ✓
- Beef
- Breakfast
- Chicken
- Dessert
- Goat
- Lamb
- Miscellaneous
- Pasta
- Pork
- Seafood
- Side
- Starter
- Vegan
- Vegetarian
- Choose by area:
- American
- British
- Canadian
- Chinese
- Dutch
- Egyptian
- French
- Greek
- Indian
- Irish
- Italian
- Jamaican
- Japanese
- Kenyan
- Malaysian
- Mexican
- Moroccan
- Russian
- Spanish
- Thai
- Tunisian
- Turkish
- Unknown
- Vietnamese
- Cocktail selection
- Create a profile and save your favourite meals
- Notation system: know what are the most loved meals
- Share recipe with your friends and family
- Suggestions based on what your personal taste
- Recipes in Video
- Get a full menu (Starter, Main, Dessert + Cocktail)
- Send a daily suggestion to newsletter
- History
- Language selection
- Nutritive value
- Add personal notes
## Supports
- Web ✓
- Progressive Web App ✓
- Mobile
## Technical Stack
- `React` client on the front-end
- [Materialize](https://materializecss.com) CSS librairy for styling
- Public API: [TheMealDb](https://www.themealdb.com/api.php) and [TheCocktailDb](https://www.thecocktaildb.com/api.php)
- Hosting: [Render](https://render.com/)
- Authentication : [Auth0](https://auth0.com/)
- Analytics : Google Analytics & Mixpanel
## Versions
### Features in v.0.1
- WebApp
- Random meal suggestion
- List of meals by categories
- Search by name: you're looking for a recipe? Ours are easy to make and yummy!
### Features in v.0.2
- Progressive Web App
- User Interface Enhancement
- Secured User Profiles
- Contact form
## TO DO
1. add sidenav on mobile
1. send message after contact form validation (confirm to sender and msg+info to admin)
1. Design & Breadcrumb
1. Cookie bar
1. code cleanup (props and refactoring)
1. Back to top button
1. Take a look at some components [here](http://react-materialize.github.io/react-materialize/?path=/story/css-grid--default)