/Recibase

A recipe ingestion and discovery service

Primary LanguageScalaApache License 2.0Apache-2.0

Recibase

Docker image build status

Recibase is a recipe ingestion and navigation service, designed to ease the choosing of what to cook.

Recibase works like so:

  1. Write Scala files containing your recipes
  2. Recibase spins up an recipe API
  3. The frontend lets you browse recipes by name, ingredient and more

There is also a separate GitHub pages site to host images of the cooked recipes and a Meal Chooser for filtering a complete list of everything we cook.

Roadmap

Recibase is a long term project which will grow depending on what features are useful or interesting to develop. The current plan is:

  1. Standardise ingredients schema
  2. Add a bunch of recipes
  3. Add any small but useful features to improve frontend
  4. Improve ingestion debugging capabilities (churn/reporting/etc.)
  5. Continue to develop schema
  6. Migrate frontend to separate React client and REST API
  7. Add microservices for useful client-side functionality (favouriting, etc.)
  8. ???
  9. Profit

Requirements

  • SBT
  • Java 17

Usage

  1. Clone Recibase
  2. Open a command prompt inside the cloned repo
  3. sbt run
  4. Wait until the program says started at http://[::]:8081/
  5. Visit localhost:8081/recipes/

If you want to use the web interface you'll need to set up the frontend too

Contributing/Questions

If you have any questions or want to help out feel free to open an issue