GithubHelp home page GithubHelp logo

skarian / foodiefinder Goto Github PK

View Code? Open in Web Editor NEW
2.0 1.0 0.0 4.42 MB

A Rust-powered desktop app using Tauri and Next.js to fetch, scrape, and locally save recipes from the web, free from ads and clutter.

License: MIT License

TypeScript 50.61% Just 0.99% JavaScript 0.13% Rust 48.27%
desktop-app edamam-api macos mit-license nextjs open-source react recipe recipe-app recipe-scraper

foodiefinder's Introduction


Logo

Foodie Finder

Recipe sites are inundated with ads and information that is distracting.

This is a convenient and private desktop application built in Tauri to find recipes from a search bar, scrape the important information and save them locally to your machine.

Overview

screenshot

Why I Built This

I am in the process of learning Rust and desktop application development. This was a fun learning experiment to get me used to syntax and community libraries.

My fiancee had expressed how messy recipe websites were and how they show so many ads. This was the inspiration for Foodie Finder.

Getting married in 2024. <3

Features

  • Search-box interface to find recipes from a text prompt
  • Scrapes websites and filters out those with incomplete datasets (much love for the recipe-scrapers library)
  • Ability to save recipes to local sqlite db

Platforms

  • Only tested on MacOS

Built With

  • Rust
  • Tauri
  • Next.js / React

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  1. Must have python 3.11 installed
  2. Must have Rust and toolchain installed

Build the application

  1. Get a free Edamam API Key (no credit card required) at https://www.edamam.com/
  2. Clone the repo
    git clone https://github.com/Skarian/foodiefinder.git
  3. Add app_id and app_key environment variables in /src-tauri/.env. Example below
    app_id=c5re916e
    app_key=19bb82b76d80a3185f88d3c2daef6315
  4. Install python dependencies pip install recipe-scrapers
  5. Install NPM dependencies npm install
  6. Run cargo tauri build
  7. The executable will be under the target folder: /src-tauri/target/. Feel free to move it wherever you prefer

Roadmap (maybe?)

  • Edit saved recipe data
  • Ability to add specific recipe URLs
  • AI-enhanced generation

Contributing

This was just a quick side project that already meets my goals. Not really looking for it to be a major open-source project but if there is community interest here I am happy to continue development.

License

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

Contact

Neil Skaria - @skar_ai - [email protected]

Project Link: https://github.com/Skarian/foodiefinder

Usage Note

This project is for demonstration / non-commercial usage only, please follow relevant regulation where appropriate

foodiefinder's People

Contributors

skarian avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.