diff --git a/.github/FUNDING.YML b/.github/FUNDING.YML new file mode 100644 index 00000000..4c472b65 --- /dev/null +++ b/.github/FUNDING.YML @@ -0,0 +1 @@ +liberapay: vishnuraghavb diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..77592434 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "[BUG]" +labels: bug +assignees: vishnuraghavb + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Device information (please complete the following information):** + - Android Version: [e.g. 8 or Oreo] + - EnRecipes Version(as in app's about page): [e.g. 1.1.4] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..73f2544b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "[FEATURE REQUEST]" +labels: enhancement +assignees: vishnuraghavb + +--- + +**Please check the [roadmap](https://github.com/vishnuraghavb/EnRecipes/projects/1) for upcoming features before proceeding** +- [ ] I've checked the roadmap and my feature request is not listed there + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..a91b488c --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,76 @@ +# Contributor Covenant 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, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, 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 apps@vishnuraghav.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. +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 + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..c63cfa8a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,23 @@ +# How to contribute + +:+1::tada: First off, thanks for taking the time to contribute! :+1::tada: + +Here are some important resources: + +- The [roadmap](https://github.com/vishnuraghavb/EnRecipes/projects/1) will tell you whats the future of EnRecipes +- You can help [translate](https://github.com/vishnuraghavb/EnRecipes/projects/2) EnRecipes in your native language(not limited to those existing in the `To do`) +- Bugs, suggestions or feedback? You can [create an issue here](https://github.com/vishnuraghavb/EnRecipes/issues) or [join the Telegram group](http://t.me/enrecipes)(quicker replies) to make the app better. + +### Instruction for translators + +1. Fork this repository and head to the `app/i18n` folder. +2. Create a new JSON file or duplicate any existing file and start translating its values. +3. The filenames should be based on this [gist](https://gist.github.com/vishnuraghavb/bf27b068acc35e331adfba66d18e2094). +4. Once done, create a new pull request. + +#### Don't know what fork means? No issues. + +1. Just [download the JSON file](https://raw.githubusercontent.com/vishnuraghavb/EnRecipes/main/app/i18n/en.default.json) and start translating its value(right side part after the colon":"). +2. Once done, share the file to the [EnRecipes Telegram group](http://t.me/enrecipes) or email it to apps@vishnuraghav.com for verification. + +If everything looks good, your translations will be included in the next update and you'll be added to the contributors list for your work. diff --git a/PRIVACY.md b/PRIVACY.md new file mode 100644 index 00000000..83146590 --- /dev/null +++ b/PRIVACY.md @@ -0,0 +1,25 @@ +# Privacy Policy + +I(Vishnu Raghav B) built the app EnRecipes as an open source app for use as is. + +## Your Privacy + +As a privacy-conscious internet user, I respect your privacy; that's why this app has NO Ads, NO User Tracking and does NOT collect or share any personal information. + +The app also does NOT use third party services that collect information used to identify you. + +## Links To Third Party Websites + +The app may contain links to other sites. If you click on a third-party link, you will be directed to that site. Please be aware that I am not responsible for the privacy policies on these websites. These sites are not subject to this privacy policy, and you should check their individual privacy policies. + +## Changes To This Privacy Policy + +I will occasionally update this Privacy Policy but only in a manner not affecting your privacy. Thus, you are advised to review this page periodically. I will notify you of any changes by posting the new privacy policy on this page. I will also change the “Last Updated” date at the end of this privacy policy. Any changes I make to the privacy policy are effective as of this Last Updated date and replace any prior privacy policies. + +If I make any material changes to this privacy policy, I will notify you by placing a prominent notice on my app. + +## Contact Information + +For any questions, suggestions or concerns regarding my privacy policy, please send me an email to apps@vishnuraghav.com. + +Last Updated: 18 December 2020 diff --git a/README.md b/README.md index 893f5f78..9a7b86cf 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,21 @@ -# EnRecipes +

-> A simple, offline recipe manager. +

A simple, offline recipe manager

+

EnRecipes is an easy to use, privacy-friendly digital cookbook that lets you create, manage and share your own recipes.

+
+

+ -EnRecipes is an easy to use, privacy-friendly digital cookbook that lets you create, manage and share your own recipes. - -## Principles - -- Privacy by Design +

+

Features - Downloads - Screenshots - Future - Contribution - Credits - License - Website - Telegram group

+
## Features - Create recipes quickly - Add photo, notes and combinations to your recipes - Organise your recipes by category -- Quickly search for your recipes +- Quickly search for your recipes either by name or ingredient - Mark recipes as favourites and add them to your Try Later list - Scale your recipe ingredients to serve more or less people - Get notified of the last time you tried a recipe @@ -25,41 +27,52 @@ EnRecipes is an easy to use, privacy-friendly digital cookbook that lets you cre - No internet access is required and never asks for any unwanted permissions - 100% free and open-source -Lots of interesting features on the way... +**Languages supported**: English, German, Tamil + +Check the [Roadmap](https://github.com/vishnuraghavb/EnRecipes/projects/1) for upcoming features. ## Downloads -You can get the latest release [here](https://github.com/vishnuraghavb/EnRecipes/releases) +You can get the latest release [here](https://github.com/vishnuraghavb/EnRecipes/releases/latest) [![PlayStore](assets/Images/google-play-badge.png)](https://play.google.com/store/apps/details?id=com.vishnuraghav.enrecipes) [![IzzyOnDroid](assets/Images/IzzyOnDroid.png)](https://apt.izzysoft.de/fdroid/index/apk/com.vishnuraghav.enrecipes) ## Screenshots -![EnRecipe](assets/Screenshots/2.png)![View Recipe](assets/Screenshots/3.png)![Ingredients](assets/Screenshots/4.png)![Edit Recipe](assets/Screenshots/5.png)![Share](assets/Screenshots/6.png)![Side Drawer](assets/Screenshots/7.png)![Mealplanner](assets/Screenshots/8.png)![Dark Mode](assets/Screenshots/10.png) +[](fastlane/metadata/android/en-US/images/phoneScreenshots/2.png)[](fastlane/metadata/android/en-US/images/phoneScreenshots/3.png)[](fastlane/metadata/android/en-US/images/phoneScreenshots/4.png)[](fastlane/metadata/android/en-US/images/phoneScreenshots/5.png)[](fastlane/metadata/android/en-US/images/phoneScreenshots/6.png)[](fastlane/metadata/android/en-US/images/phoneScreenshots/7.png)[](fastlane/metadata/android/en-US/images/phoneScreenshots/8.png)[](fastlane/metadata/android/en-US/images/phoneScreenshots/10.png) ## Having issues, suggestions and feedback? -You can add an issue [here](https://github.com/vishnuraghavb/EnRecipes/issues) or [join the Telegram group](http://t.me/enrecipes)(quicker replies) +You can [create an issue here](https://github.com/vishnuraghavb/EnRecipes/issues) or [join the Telegram group](http://t.me/enrecipes)(quicker replies) ## Future - [Roadmap](https://github.com/vishnuraghavb/EnRecipes/projects/1) -- [Translations](https://github.com/vishnuraghavb/EnRecipes/projects/1) - Contributors are welcome! No technical knowledge is required. +- [Translations](https://github.com/vishnuraghavb/EnRecipes/projects/2) - Contributors are welcome! + +## Contributors + +- [mondstern](https://codeberg.org/mondstern) (Translator) +- [epicalxyz](https://github.com/epicalxyz) (Translator) + +### Want to contribute? + +Please read the [CONTRIBUTING.md](https://github.com/vishnuraghavb/EnRecipes/blob/main/CONTRIBUTING.md) ## Credits +This app was written in my free time using NativeScript. I would like to thank all those people who helped me understand the concepts during the process and my special thanks to the NativeScript team and the community. + ### Recipes used in the Screenshots - **Meen Pollichathu** by [Bency Veronica](https://www.instagram.com/bencys_lil_kitchen) - **Curd Vada** by P. Shanmugalakshmi - **Roasted Chicken Biriyani** by [Ranga](https://www.youtube.com/channel/UC6ONI92scjwMmk3IITKIx-g) -This app was written in my free time using NativeScript. I would like to thank all those people who helped me understand the concepts during the process and my special thanks to the NativeScript team and the community. +## Principles -## Contributors - -- [mondstern](https://codeberg.org/mondstern) (Translator) +- Privacy by Design ## Technologies diff --git a/app/components/App.vue b/app/components/App.vue index 7827dbc0..df9d3076 100644 --- a/app/components/App.vue +++ b/app/components/App.vue @@ -1,22 +1,21 @@