marceliwanicki / freat Goto Github PK

Freat is an open-source variation of a smart recipe app designed to make cooking easier and more enjoyable. It allows users to import products from receipt/bill scans, calculates available ingredients, and suggests recipes based on what's in your kitchen.

Here's why Freat is awesome:

• Smart import of products from receipt/bill scans
• Intelligent calculation and suggestion of recipes based on available ingredients
• Open-source and community-driven development

Feel free to contribute by forking this repo and creating a pull request or opening an issue. Your feedback and contributions are highly appreciated!

(back to top)

This section should list any major frameworks/libraries used to build your project. Here are a few examples for a Compose Multiplatform project.

• 
• 
• SqlDelight
• Compose Multiplatform
• Voyager
• Moko
• Koin
• JUnit
• Turbine

(back to top)

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running, follow these simple example steps.

This is an example of how to list things needed to build and run the app.

• Android Studio
• Kotlin

1. Clone the repo

   git clone https://github.com/MarcelIwanicki/freat.git

2. Open the project in Android Studio

3. Build and run the app on your Android device or emulator

(back to top)

Use this space to showcase useful examples of how to use the app. You can include screenshots, code examples, and demos to illustrate its features.

(back to top)

• Smart import of products from receipt scans
• Intelligent calculation and suggestion of recipes
• Integrate project with Bitrise CI/CD
• Material You support
• Cover code with unit tests
• Cover code with UI tests
• Production ready on iOS
• Improve recipe scanning algorithm
• Improve string similarity algorithm
• Multi-language support
  • English
  • Other languages - IN PROGRESS

See the open issues for a full list of proposed features and known issues.

(back to top)

Contributions are welcome! If you have suggestions, enhancements, or bug fixes, please follow these steps:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Marcel Iwanicki - @marcel-iwanicki - [email protected]

Project Link: https://github.com/MarcelIwanicki/freat

(back to top)

Use this space to give credit to resources that have been helpful. Here are a few to start:

• Android Developer Documentation
• JetBrains Kotlin Documentation
• Compose Multiplatform Documentation