enrecipes/README.md

118 lines
7.6 KiB
Markdown
Raw Normal View History

2021-05-02 07:20:38 +00:00
<p align="center"><a href="https://enrecipes.vercel.app"><img src="fastlane/metadata/android/en-GB/images/featureGraphic.png" width="100%"></a></p>
2020-09-15 11:10:16 +00:00
2021-03-08 09:48:43 +00:00
<h1 align="center">A Simple, Offline Recipe Manager</h1>
<p align="center">EnRecipes is an open source, privacy-friendly digital cookbook that lets you create, manage and share your recipes.</p>
2020-12-14 11:28:50 +00:00
<p align="center">
2021-03-08 09:48:43 +00:00
<a href="https://www.gnu.org/licenses/gpl-3.0" alt="License: GPLv3"><img src="https://img.shields.io/badge/license-GPL%20v3-blue"></a> <a href="https://github.com/vishnuraghavb/EnRecipes/releases" alt="Release version"><img src="https://img.shields.io/github/v/release/vishnuraghavb/EnRecipes?color=ff5200"/></a> <a href="https://hosted.weblate.org/engage/enrecipes/">
<img src="https://hosted.weblate.org/widgets/enrecipes/-/app-translations/svg-badge.svg" alt="Translation status" /></a>
<p align="center">
2021-05-27 17:20:10 +00:00
<a href="https://play.google.com/store/apps/details?id=com.vishnuraghav.enrecipes"><img src="assets/Images/google-play-badge.png" height="80"/></a><a href="https://apt.izzysoft.de/fdroid/index/apk/com.vishnuraghav.enrecipes"><img src="assets/Images/IzzyOnDroid.png" height="80"/></a><br>You can also get the <a href="https://github.com/vishnuraghavb/EnRecipes/releases/latest">latest release on GitHub</a>
2021-03-08 09:48:43 +00:00
</p>
<h2 align="center">Enjoying EnRecipes?</h2>
<p align="center">Please consider making a small donation to help fund the project. Developing an application, especially one that is open source and completely free, takes a lot of time and effort.
<br>
<br>
<a href="https://www.vishnuraghav.com/donate/"><img alt="Donate to Vishnu Raghav" src="assets/Images/donate.svg" width="240"></a></p>
2020-12-29 21:28:18 +00:00
<hr>
2021-03-08 09:48:43 +00:00
<h3 align="center">Important Links</h3>
<p align="center"><a href="https://github.com/vishnuraghavb/EnRecipes/wiki/User-Guide">User Guide</a> - <a href="https://github.com/vishnuraghavb/EnRecipes/blob/main/PRIVACY.md">Privacy Policy</a> - <a href="https://github.com/vishnuraghavb/EnRecipes/blob/main/CONTRIBUTING.md">Contribution Guide</a> - <a href="https://github.com/vishnuraghavb/EnRecipes/projects/1">Roadmap</a> - <a href="https://t.me/enrecipes/">Telegram Group</a> - <a href="https://enrecipes.vercel.app/">Website</a></p>
2020-12-14 11:28:50 +00:00
<hr>
2020-11-12 12:59:32 +00:00
## Features
2020-11-12 12:59:32 +00:00
2021-03-08 09:48:43 +00:00
- Create recipes quickly
2021-04-23 14:49:35 +00:00
- Add photo, combinations and notes to your recipes
2021-03-08 09:48:43 +00:00
- Organise your recipes by cuisine, category and tags
2021-04-23 14:49:35 +00:00
- Add recipes to your Try Later list and mark them as favourites
2021-03-08 09:48:43 +00:00
- Quickly search for recipes by title or ingredient
- Scale your recipe ingredients to serve more or less people
- Get notified of the last time you tried a recipe
2021-04-23 14:49:35 +00:00
- Share your recipe to anyone by any means as a nicely formatted message. You can share the recipe photo too.
2021-03-08 09:48:43 +00:00
- Shake device to view random recipe
- Create meal plans
- Import/Export recipes
2021-04-23 14:49:35 +00:00
- Light, Dark and Black themes
2021-01-23 17:20:15 +00:00
## Highlights
2021-03-08 09:48:43 +00:00
- 100% free and open-source
- Private by Design
2021-04-23 14:49:35 +00:00
- No permissions required
2021-03-08 09:48:43 +00:00
- No annoying ads or pop-ups
2020-11-12 12:59:32 +00:00
2021-03-08 09:48:43 +00:00
**Languages being translated**:
2020-12-29 21:28:18 +00:00
2021-03-08 09:48:43 +00:00
[![Translation status](https://hosted.weblate.org/widgets/enrecipes/-/app-translations/multi-auto.svg)](https://hosted.weblate.org/engage/enrecipes/)
2020-09-15 11:10:16 +00:00
2021-03-08 09:48:43 +00:00
Check the [Roadmap](https://github.com/vishnuraghavb/EnRecipes/projects/1) for upcoming features.
2020-09-15 11:10:16 +00:00
2021-03-08 09:48:43 +00:00
Please read the [User Guide](https://github.com/vishnuraghavb/EnRecipes/wiki/User-Guide) to get the most out of EnRecipes.
2020-12-12 21:01:47 +00:00
## Screenshots
2021-05-02 07:20:38 +00:00
| <img src="fastlane/metadata/android/en-GB/images/phoneScreenshots/1.png" width=276> | <img src="fastlane/metadata/android/en-GB/images/phoneScreenshots/2.png" width=276> |
2021-04-23 14:49:35 +00:00
| :---------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------: |
| **Home - Light theme** | **Home - Dark theme** |
2021-05-02 07:20:38 +00:00
| <img src="fastlane/metadata/android/en-GB/images/phoneScreenshots/3.png" width=276> | <img src="fastlane/metadata/android/en-GB/images/phoneScreenshots/4.png" width=276> |
2021-04-23 14:50:22 +00:00
| **Home - Black theme** | **Recipe view** |
2021-05-02 07:20:38 +00:00
| <img src="fastlane/metadata/android/en-GB/images/phoneScreenshots/5.png" width=276> | <img src="fastlane/metadata/android/en-GB/images/phoneScreenshots/6.png" width=276> |
2021-04-23 14:49:35 +00:00
| **Share menu** | **Scale ingredients** |
2021-05-02 07:20:38 +00:00
| <img src="fastlane/metadata/android/en-GB/images/phoneScreenshots/7.png" width=276> | <img src="fastlane/metadata/android/en-GB/images/phoneScreenshots/8.png" width=276> |
2021-04-23 14:50:22 +00:00
| **Meal planner** | **About** |
2021-03-08 09:48:43 +00:00
## Contribution
2021-03-08 09:48:43 +00:00
Check out the [Roadmap](https://github.com/vishnuraghavb/EnRecipes/projects/1) and [Issues](https://github.com/vishnuraghavb/EnRecipes/issues) before proceeding.
2020-12-29 21:28:18 +00:00
2021-03-08 09:48:43 +00:00
Your feedback and suggestions are very important to make EnRecipes the best. If you have an idea to improve EnRecipes, [join the Telegram group](#having-issues-suggestions-and-feedback) to start discussing. I'm always open to ideas ;)
2020-12-29 21:28:18 +00:00
2021-03-08 09:48:43 +00:00
### Having issues, suggestions and feedback?
2021-03-08 09:48:43 +00:00
You can,
2021-01-02 07:18:03 +00:00
2021-03-08 09:48:43 +00:00
- [Create an issue here](https://github.com/vishnuraghavb/EnRecipes/issues)
- [Join the Telegram group](http://t.me/enrecipes) (quicker replies)
- Contact me at apps@vishnuraghav.com
2020-12-29 21:28:18 +00:00
2021-03-08 09:48:43 +00:00
### Looking to translate the app to your own language?
2020-12-29 21:28:18 +00:00
2021-01-02 07:18:03 +00:00
EnRecipes is being translated using [Weblate](https://hosted.weblate.org/engage/enrecipes/). See [translation instructions](https://github.com/vishnuraghavb/EnRecipes/wiki/Translation-Instructions) in the wiki for more information.
2020-12-29 21:28:18 +00:00
<a href="https://hosted.weblate.org/engage/enrecipes/">
<img src="https://hosted.weblate.org/widgets/enrecipes/-/app-translations/287x66-grey.png" alt="Translation status" />
</a>
2020-12-13 11:44:46 +00:00
2020-12-13 11:47:11 +00:00
## Credits
2021-01-01 19:41:37 +00:00
This app was written in my free time using NativeScript-Vue. 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. I also would like to thank the members of the [EnRecipes Telegram group](https://t.me/enrecipes) for contributing their ideas for this project.
2020-12-13 11:47:11 +00:00
### Recipes used in the Screenshots
2021-03-08 09:48:43 +00:00
- **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)
2020-12-13 11:47:11 +00:00
2020-12-29 21:28:18 +00:00
### Assets
2021-03-08 09:48:43 +00:00
- Icon font and Logo by [Vishnu Raghav](https://www.vishnuraghav.com/)
2020-11-12 12:59:32 +00:00
## License
2021-03-08 09:48:43 +00:00
<a href="http://www.gnu.org/licenses/gpl-3.0.en.html" rel="nofollow"><img src="https://camo.githubusercontent.com/317e8956b95d7cd7ebdc2a75b836f19dee3c1ae5fa0fce5b277338e648880d4f/68747470733a2f2f7777772e676e752e6f72672f67726170686963732f67706c76332d3132377835312e706e67" alt="GNU GPLv3 Image"></a>
EnRecipes - A Simple, Offline Recipe Manager
Copyright (C) 2020 Vishnu Raghav B
2020-11-12 12:59:32 +00:00
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
2020-11-12 12:59:32 +00:00
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
2020-11-12 12:59:32 +00:00
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.