From 0967f5f2ad541fcfbb915ca8ab98af4904a1d43d Mon Sep 17 00:00:00 2001 From: Ruidy Nemausat Date: Fri, 3 Apr 2020 22:21:54 +0200 Subject: [PATCH] Documentation --- CHANGELOG.md | 15 ++++++++ CONTRIBUTING.md | 92 +++++++++++++++++++++++++++++++++++++++++++++++++ LICENSE.md | 21 +++++++++++ README.md | 53 ++++++++++++++-------------- TODO.md | 10 ++++++ 5 files changed, 164 insertions(+), 27 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE.md create mode 100644 TODO.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..7c2cddf --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,15 @@ +# CHANGELOG + +## 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! + +## v.0.2 + +- Progressive Web App +- User Interface Enhancement +- Secured User Profiles +- Contact form diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9f1ab7b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,92 @@ +# Contributing + +When contributing to this repository, please first discuss the change you wish to make via issue, +email, or any other method with the owners of this repository before making a change. + +Please note we have a code of conduct, please follow it in all your interactions with the project. + +## Pull Request Process + +1. Ensure any install or build dependencies are removed before the end of the layer when doing a + build. +2. Update the README.md with details of changes to the interface, this includes new environment + variables, exposed ports, useful file locations and container parameters. +3. Increase the version numbers in any examples files and the README.md to the new version that this + Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). +4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you + do not have permission to do that, you may request the second reviewer to merge it for you. + +## Code of Conduct + +### Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +### Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +### Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +### Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +### Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at [INSERT EMAIL ADDRESS]. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +### Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..3da3ee5 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +# MIT License + +Copyright (c) 2020 Ruidy Nemausat + +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. diff --git a/README.md b/README.md index d937e3c..d1cfb1a 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Free meal planner for cooks short on ideas! (like me …) [v.0.1 Available Here!](https://chefs-meal-planner.onrender.com/) -## Features +## Feature list - Random meal suggestion ✓ - Search by name: you're look for a recipe? Ours are easy to make and Yummy! ✓ @@ -68,37 +68,36 @@ Free meal planner for cooks short on ideas! (like me …) - Progressive Web App ✓ - Mobile -## Technical Stack +## Deployment -- `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 +The application is hosted on [Render](https://render.com/) at the following address: [link](https://chefs-meal-planner.onrender.com/). -## Versions +## Built With -### Features in v.0.1 +- [React](https://reactjs.org/) - A JavaScript library for building user interfaces +- [Materialize](https://materializecss.com) - Modern responsive CSS framework based on Material Design by Google +- [TheMealDb](https://www.themealdb.com/api.php) - An open, crowd-sourced database of Recipes from around the world + +- [Auth0](https://auth0.com/) - Rapidly integrate authentication and authorization +- [Render](https://render.com/) - The Easiest Cloud For All Your Apps and Websites + -- 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! +## Contributing -### Features in v.0.2 +Please read [CONTRIBUTING.md](https://github.com/rjNemo/meal_planner/contributors) for details on our code of conduct, and the process for submitting pull requests to us. -- Progressive Web App -- User Interface Enhancement -- Secured User Profiles -- Contact form +## Versioning -## TO DO +We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/rjNemo/meal_planner/tags). -1. send message after contact form validation (confirm to sender and msg+info to admin) -1. Local storage of prefeernces -1. 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) +## Authors + +- **Ruidy Nemausat** - _Initial work_ - [GitHub](https://github.com/rjNemo) + +See also the list of [contributors](https://github.com/rjNemo/meal_planner/contributors) who participated in this project. + +## License + +This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details + + diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..05fe557 --- /dev/null +++ b/TODO.md @@ -0,0 +1,10 @@ +# TO DO + +- [ ] send message after contact form validation (confirm to sender and msg+info to admin) +- [ ] Local storage of prefeernces +- [ ] Breadcrumb +- [ ] Cookie bar +- [ ] code cleanup (props and refactoring) +- [ ] Back to top button +- [ ] Close Sidebar at outside click +- [ ] Take a look at some components [here](http://react-materialize.github.io/react-materialize/?path=/story/css-grid--default)