diff --git a/README.md b/README.md index 859d27a..dbcd8f0 100644 --- a/README.md +++ b/README.md @@ -1,68 +1,80 @@ -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +# Chef's Meal Planner -## Available Scripts +Free meal planner for cooks short on ideas! (like me …) -In the project directory, you can run: +## Features -### `npm start` +- 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 -Runs the app in the development mode.
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser. +* Cocktail selection -The page will reload if you make edits.
-You will also see any lint errors in the console. +- Create a profile and save your favourite meals +- Notation system: know what are the most loved meals +- Suggestions based on what your personal taste +- Recipes in Video -### `npm test` +## Supports -Launches the test runner in the interactive watch mode.
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. +- Web +- Progressive Web App +- Mobile -### `npm run build` +## Technical Stack -Builds the app for production to the `build` folder.
-It correctly bundles React in production mode and optimizes the build for the best performance. +- `React` client on the front-end -The build is minified and the filenames include the hashes.
-Your app is ready to be deployed! +* [Material UI](https://material-ui.com/) component librairy for styling -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. +- Public API: [TheMealDb](https://www.themealdb.com/api.php) and [TheCocktailDb](https://www.thecocktaildb.com/api.php) +- Hosting: anywhere -### `npm run eject` +## Versions -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** +### Features in V.1 -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. +- WebApp +- Random meal suggestion -Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. - -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. - -## Learn More - -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/). - -### Code Splitting - -This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting - -### Analyzing the Bundle Size - -This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size - -### Making a Progressive Web App - -This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app - -### Advanced Configuration - -This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration - -### Deployment - -This section has moved here: https://facebook.github.io/create-react-app/docs/deployment - -### `npm run build` fails to minify - -This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify +* Search by name: you're look for a recipe? Ours are easy to make and Yummy! diff --git a/public/index.html b/public/index.html index aa069f2..2e0ef92 100644 --- a/public/index.html +++ b/public/index.html @@ -10,34 +10,11 @@ content="Web site created using create-react-app" /> - - - React App + Chef's Meal Planner
- diff --git a/public/manifest.json b/public/manifest.json index 080d6c7..9a0ef6e 100644 --- a/public/manifest.json +++ b/public/manifest.json @@ -1,6 +1,6 @@ { - "short_name": "React App", - "name": "Create React App Sample", + "short_name": "Meal Planner", + "name": "Chef's Meal Planner", "icons": [ { "src": "favicon.ico", @@ -22,4 +22,4 @@ "display": "standalone", "theme_color": "#000000", "background_color": "#ffffff" -} +} \ No newline at end of file diff --git a/src/index.js b/src/index.js index 87d1be5..90fb3f6 100644 --- a/src/index.js +++ b/src/index.js @@ -1,12 +1,9 @@ -import React from 'react'; -import ReactDOM from 'react-dom'; -import './index.css'; -import App from './App'; -import * as serviceWorker from './serviceWorker'; +import React from "react"; +import ReactDOM from "react-dom"; +import "./index.css"; +import App from "./App"; +import * as serviceWorker from "./serviceWorker"; -ReactDOM.render(, document.getElementById('root')); +ReactDOM.render(, document.getElementById("root")); -// If you want your app to work offline and load faster, you can change -// unregister() to register() below. Note this comes with some pitfalls. -// Learn more about service workers: https://bit.ly/CRA-PWA serviceWorker.unregister();