enrecipes/README.md

119 lines
8 KiB
Markdown
Raw Normal View History

2020-12-14 11:30:40 +00:00
<p align="center"><a href="https://enrecipes.vercel.app"><img src="fastlane/metadata/android/en-US/images/featureGraphic.png" width="100%"></a></p>
2020-09-15 11:10:16 +00:00
2020-12-14 11:28:50 +00:00
<h3 align="center">A simple, offline recipe manager</h3>
<h4 align="center">EnRecipes is an easy to use, privacy-friendly digital cookbook that lets you create, manage and share your own recipes.</h4>
<br>
<p align="center">
2020-12-29 21:28:18 +00:00
<a href="https://github.com/vishnuraghavb/EnRecipes/releases" alt="Release version"><img src="https://img.shields.io/github/v/release/vishnuraghavb/EnRecipes?label=Release"></a> <a href="https://github.com/vishnuraghavb/EnRecipes/releases" alt="Release date"><img src="https://img.shields.io/github/release-date/vishnuraghavb/EnRecipes?color=blue&label=Release%20date"></a> <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/issues" alt="GitHub issues"><img src="https://img.shields.io/github/issues/vishnuraghavb/EnRecipes?label=Issues"></a> <a href="https://liberapay.com/vishnuraghavb/donate" alt="Translation Status"><img src="https://img.shields.io/liberapay/patrons/vishnuraghavb.svg?logo=liberapay"></a>
2020-09-15 11:10:16 +00:00
2020-12-14 11:28:50 +00:00
<hr>
2020-12-29 21:28:18 +00:00
<p align="center"><a href="#features">Features</a> - <a href="#downloads">Downloads</a> - <a href="#screenshots">Screenshots</a> - <a href="#future">Future</a> - <a href="#contributors">Contributors</a> - <a href="#credits">Credits</a> - <a href="#license">License</a></p>
<hr>
<p align="center"><a href="https://github.com/vishnuraghavb/EnRecipes/wiki/User-Guide">User Guide</a> - <a href="https://github.com/vishnuraghavb/EnRecipes/projects/1">Roadmap</a> - <a href="https://github.com/vishnuraghavb/EnRecipes/blob/main/CONTRIBUTING.md">Contribution Guide</a> - <a href="https://github.com/vishnuraghavb/EnRecipes/blob/main/PRIVACY.md">Privacy Policy</a> - <a href="https://t.me/enrecipes/">Telegram Group</a> - <a href="https://enrecipes.vercel.app/">Website</a> - <a href="https://www.vishnuraghav.com/donate/">Donate</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
- Create recipes quickly
- Add photo, notes and combinations to your recipes
2020-12-29 10:35:19 +00:00
- Organise your recipes by cuisine, category and tags
- Mark recipes as Favourites and add them to your Try Later list
2020-12-29 21:28:18 +00:00
- Quickly search for recipes by name, ingredient or tag
- Scale your recipe ingredients to serve more or less people
- Get notified of the last time you tried a recipe
2020-12-29 10:35:19 +00:00
- Share your recipe to anyone by any means as a nicely formatted message. You can share the recipe photo too
2020-12-29 21:28:18 +00:00
- Shake device to view random recipe
- Create meal plans
- Import/Export recipes
- Light & Dark theme
- No annoying ads or pop-ups
- No internet access is required and never asks for any unwanted permissions
2020-12-29 21:28:18 +00:00
- Private by Design
- 100% free and open-source
2020-11-12 12:59:32 +00:00
2020-12-29 10:35:19 +00:00
**Languages supported**: Danish, Dutch, English, German, Portuguese, Russian, Spanish and Tamil
2020-12-13 14:13:27 +00:00
Check the [Roadmap](https://github.com/vishnuraghavb/EnRecipes/projects/1) for upcoming features.
2020-11-12 12:59:32 +00:00
2020-12-29 21:28:18 +00:00
Please read the <a href="https://github.com/vishnuraghavb/EnRecipes/wiki/User-Guide">User Guide</a> to get the most out of EnRecipes.
## Downloads
2020-09-15 11:10:16 +00:00
2020-12-14 11:28:50 +00:00
You can get the latest release [here](https://github.com/vishnuraghavb/EnRecipes/releases/latest)
2020-09-15 11:10:16 +00:00
[![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)
2020-12-12 21:01:47 +00:00
## Screenshots
2020-12-29 21:28:18 +00:00
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/1.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/1.png)[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/2.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/2.png)[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/3.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/3.png)[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/4.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/4.png)[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/5.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/5.png)[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/6.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/6.png)[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/7.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/7.png)[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/8.png" width=276>](fastlane/metadata/android/en-US/images/phoneScreenshots/8.png)
2020-12-12 21:01:47 +00:00
## Having issues, suggestions and feedback?
2020-12-02 09:46:25 +00:00
2020-12-29 21:28:18 +00:00
You can,
- [Create an issue here](https://github.com/vishnuraghavb/EnRecipes/issues)
- [Join the Telegram group](http://t.me/enrecipes) (quicker replies and best for discussion)
- Contact me at apps@vishnuraghav.com
## Future
2020-12-29 21:28:18 +00:00
Check out the [roadmap](https://github.com/vishnuraghavb/EnRecipes/projects/1) to see the upcoming features of EnRecipes.
Your feedback and suggestions are very important to make EnRecipes the best. If you have an idea to improve EnRecipes, [do let me know](#having-issues-suggestions-and-feedback). I'm always open to ideas ;)
With the help of contributors around the world, EnRecipes currently supports a set of few languages. See the list of currently supported languages [here](https://github.com/vishnuraghavb/EnRecipes/projects/2).
If you know to read and write in your native language, then you are all set to translate EnRecipes in your native language. Want to contribute? Please read the [Contribution Guide](https://github.com/vishnuraghavb/EnRecipes/blob/main/CONTRIBUTING.md)
2020-12-02 09:46:25 +00:00
## Contributors
2020-12-29 21:28:18 +00:00
- [mondstern](https://codeberg.org/mondstern) (Translations: Danish, Dutch and German)(discontinued)
2020-12-29 10:35:19 +00:00
- [EpicalXYZ](https://github.com/epicalxyz) (Translations: Portuguese)
- [dm9pZCAq](https://github.com/dm9pZCAq) (Translations: Russian)
- [AHaro88](https://github.com/taraletti) (Translations: Spanish)
2020-12-29 21:28:18 +00:00
- [RAPXT](https://github.com/RAPXT) (Translations: German)
### Translators wanted!
[mondstern](https://codeberg.org/mondstern) recently discontinued maintaining the Danish and Dutch translations. So it would be great if you could maintain these languages and help EnRecipes reach more people.
Interested? Please read the [Contribution Guide](https://github.com/vishnuraghavb/EnRecipes/blob/main/CONTRIBUTING.md)
2020-12-13 11:44:46 +00:00
2020-12-13 11:47:11 +00:00
## Credits
2020-12-29 21:28:18 +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 Telegram EnRecipes group for contributing their ideas for this project.
2020-12-13 11:47:11 +00:00
### 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)
2020-12-29 21:28:18 +00:00
### Assets
- [Boxicons](https://boxicons.com/)
- Logo by [Vishnu Raghav](https://www.vishnuraghav.com/)
2020-11-12 12:59:32 +00:00
## License
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/>.
2020-12-29 21:28:18 +00:00
## Support me
<a href="https://www.vishnuraghav.com/donate/"><img alt="Donate to Vishnu Raghav" src="assets/Images/donate.svg" width="207"></a>