enrecipes/README.md
2020-12-13 17:17:11 +05:30

106 lines
4.2 KiB
Markdown

# EnRecipes
> 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.
## Principles
- Privacy by Design
## Features
- Create recipes quickly
- Add photo, notes and combinations to your recipes
- Organise your recipes by category
- Quickly search for your recipes
- 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
- Share your recipe to anyone by any means as a nicely formatted message. You can share the recipe photo too.
- 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
- 100% free and open-source
Lots of interesting features on the way...
## Downloads
You can get the latest release [here](https://github.com/vishnuraghavb/EnRecipes/releases)
[![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)
## 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)
## 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.
## Contributors
- [mondstern](https://codeberg.org/mondstern) (Translator)
### Instruction for translators
You can contribute by translating EnRecipes in your native language.
1. Fork this repository and head to this `app/i18n` folder.
2. Create a new JSON file or duplicate any existing file and start translating its values.
3. The filename should be as follows, `fr.json` for french
4. Once done, create a merge 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) 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.
## 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)
## Technologies
- NativeScript-Vue
## Assets
- [Boxicons](https://boxicons.com/)
- Logo by [Vishnu Raghav](https://www.vishnuraghav.com/)
## License
EnRecipes - a simple, offline recipe manager.
Copyright (C) 2020 Vishnu Raghav B
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.
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.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.