diff --git a/.gitignore b/.gitignore index 19d6a6b..b9988c2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ build/ node_modules/ -/.idea +.idea/ +.vscode/ .env \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9f1ab7b..d5c6d02 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,19 +1,19 @@ # 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. +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 +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 +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 +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 @@ -32,21 +32,21 @@ orientation. 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 +- 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 +- 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 +- Other conduct which could reasonably be considered inappropriate in a professional setting ### Our Responsibilities @@ -73,7 +73,7 @@ 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 +reported by contacting the project team at ruidy.nemausat@gmail.com. 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. diff --git a/LICENSE.md b/LICENSE.md index 3da3ee5..18a8b5a 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # MIT License -Copyright (c) 2020 Ruidy Nemausat +Copyright (c) 2021 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 diff --git a/README.md b/README.md index e5f4129..7fb3779 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,28 @@ -[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/rjNemo/meal_planner) - # Chef's Meal Planner +![header image](https://socialify.git.ci/rjnemo/meal_planner/image?description=1&font=Raleway&language=1&logo=https%3A%2F%2Fchefs-meal-planner.onrender.com%2Flogo192.png&owner=1&pattern=Diagonal%20Stripes&stargazers=1&theme=Dark) + +[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod&style=for-the-badge)](https://gitpod.io/#https://github.com/rjNemo/meal_planner) +![license](https://img.shields.io/github/license/rjNemo/meal_planner?style=for-the-badge) +![release tag](https://img.shields.io/github/v/release/rjNemo/meal_planner?style=for-the-badge) + Free meal planner for cooks short on ideas! (like me …) -[v.0.1 Available Here!](https://chefs-meal-planner.onrender.com/) +## Demo + +[🚀 App live at this address!](https://chefs-meal-planner.onrender.com/) + +![Screenshot](docs/short_clip.gif) + +### Screenshot + +#### Home page + +![Screenshot](docs/homepage.png) + +#### Meal page + +![Screenshot](docs/mealpage.png) ## Feature list diff --git a/docs/homepage.png b/docs/homepage.png new file mode 100644 index 0000000..00c9c51 Binary files /dev/null and b/docs/homepage.png differ diff --git a/docs/mealpage.png b/docs/mealpage.png new file mode 100644 index 0000000..e9e487e Binary files /dev/null and b/docs/mealpage.png differ diff --git a/docs/short_clip.gif b/docs/short_clip.gif new file mode 100644 index 0000000..8c2f273 Binary files /dev/null and b/docs/short_clip.gif differ