Skip to content

horvbalint/recet

Repository files navigation

Recet

What is this?

Recet is an open source, work in progress recipe manager application built using Nuxt and SurrealDB. It is motivated from personal needs and the curiosity to see how much functionality can be squeezed out from using SurrealDB as the backend. My goal is to create a web app that feels great on both desktop and mobile using modern technologies like PWA, View Transition API, all while showcasing many features of SurrealDB.

Functionality

I plan to create the following modules:

  • Authentication ✅
  • Households ✅
  • Master data managment ✅
  • Recipes ✅
  • Shopping lists ✅
  • Meal planner ✅
  • Recipe import from websites or text ✅
  • Recipe AI ❌

Polish

  • Mobile ✅
  • PWA ✅
  • View Transitions ✅
  • Dark Mode ✅

✅ - Working 👷‍♀️ - Work in progress ❌ - Coming later

Screenshots

A screenshot showing the recipes page

A screenshot showing the recipes page A screenshot showing the recipes page

Start/Deploy

The project uses Nuxt.js and SurrealDB. It needs a DB instance running with the structure defined in db.surql. The project uses two currently experimental features:

  • files: for this to work the SURREAL_BUCKET_FOLDER_ALLOWLIST env var has to be set
  • surrealism: the recet.surli plugin in the surreal-plugin directory has to be copied into the plugins bucket's directory

These experimental features are available in the v3 versions of SurrealDB.

Steps:

  • clone the repo
  • pnpm i
  • pnpm run dev
  • it should be running on port 3000

It looks for the database at 'http://localhost:8000' by default, but this can be changed with the NUXT_PUBLIC_SURREAL_DB_URL enviroment variable.

About

An open source recipe manager

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors