• Worked on this project for:

Introduction

This project is in a very early stage, many updates coming soon.

• Lemonotes is a Progressive Web App that allows you to create, save, organize, reorder and re-cook all your recipes, collecting them in an intuitive and convenient way to find them quickly and easily.
• This web-based project will allow you to collect your culinary recipes neatly.
• This app offers a user-friendly interface for efficient navigation and quick access to the information you need

📒 Index

• About
• Usage
  • Installation
• Development
  • Pre-Requisites
  • File Structure
• Community
  • Contribution
  • Branches
  • Guideline
• FAQ
• Gallery
• Credit/Acknowledgment
• License

🔰 About

Lemonotes is the perfect app for cooking lovers who want to keep track of their recipes easily and effectively. Designed with an intuitive and friendly interface, Lemonotes allows you to save and organize your recipes quickly and conveniently, without the need for an internet connection.
With Lemonotes, you can categorize your recipes based on a wide range of criteria, including number of ingredients, average cost, preparation time, difficulty and many more, making it easy to find exactly what you're looking for at any time .
Lemonotes offers you the ability to share your recipes as images, allowing you to inspire your friends and family easily and instantly.

⚡ Usage

to do

🔌 Installation

You can get this app in many ways.

• Since this app now follows the guidelines to be installed as PWA (Progressive Web App) you can open this app from the github pages link (on top of this page) and then accept the prompt to install or if it doesn't appear for any reason click the three dots on the top-right of your browser and tap "Install App" to get the WebApp available in your Android smartphone. This way usually offers a better experience. You will automatically the updates remotely and you won't need to be connected to the internet to use it normally.
• Otherwise you can always use the link to connect to github pages. Your data is saved in IndexedDB, so it will always stay on your phone.
• I also plan to make an actual apk application for android using a PWA builder service in the future.

🔧 Development

📓 Pre-Requisites

There are no special prerequisites for this project other than the following:

• A chromium browser like Google Chrome, Brave, Edge, Opera... (Not optimised for Safari and Firefox, which may not be compatible with some CSS rules)
• An internet connection (not always required if you install the WebApp)
• Compatibility with browser's IndexedDB functionality

📁 File Structure

I will try to keep the repository structure as clean as possible to make maintenance and community contributions clearer

> to do

🌸 Community

Teamwork is important! If you want to contribute and help in this project, fixing bugs, adding features or changing the look and feel of the page feel free to contribute!

🔥 Contribution

Feel free to contribute as much as you'd like!

1. Report a bug
   If you think you have encountered a bug, and I should know about it, feel free to report it and I will take care of it.

2. Request a feature
   You can also request for a feature and if it will viable, it will be picked for development.

3. Create a pull request
   It can't get better then this, your pull request will be appreciated by the community. You can get started by picking up any open issues and make a pull request.

If you are new to open-source, make sure to check read more about it here and learn more about creating a pull request here.

🌵 Branches

1. stage is the development branch.

2. master is the production branch.

3. No other permanent branches should be created in the main repository, you can create feature branches but they should get merged with the master.

Steps to work with feature branch

1. To start working on a new feature, create a new branch prefixed with feat and followed by feature name. (ie. feat-FEATURE-NAME)
2. Once you are done with your changes, you can raise PR.

❗ Guideline

There are no particular guidelines to follow to contribute to the project.
Feel free to change whatever you want however you want, but try to keep the code tidy and readable.

❓ FAQ

• What's this thing?
  This is lemonotes, the app to easily organize and collect your culinary creations.

• What can I do with it?
  With Lemonotes, users can do a variety of things to enhance their cooking experience. Firstly, they can save their favorite recipes within the app, whether they're family recipes passed down through generations or newfound culinary discoveries. Lemonotes allows users to organize their recipes using various criteria such as ingredients, cost, preparation time, difficulty level, and more, enabling them to quickly find recipes that match their preferences or dietary needs.

• Can I contribute to this?
  Yes, absolutely! Contributions are always well-accepted! To know more, go to the contribution section of this readme

• How are you?
  It's a little cold at home now, I think I'll put on a sweater. Thanks for asking <3

📷 Gallery

to do

🌟 Credit/Acknowledgment

I'm the only one that worked on this as of now :')

🔒 License

This project is licensed with MIT License. You can practically do anything with this code and also reuse it for commerical purposes. Read the full License file for more specific details.