Skip to content

mikebgrep/forkapi

Repository files navigation

ForkAPI

version License: BSD-3-Clause build Docker pulls

Logo

ForkApi is a Lightweight RestAPI with admin panel to manage food recipes easily.

  • 🐍 Python Django & Django rest framework based
  • 🛳 Dockerfile for easy deployment + included packages for Raspberry Pi.
  • 👨‍🍳 Admin panel revamped with jazzmin
  • 🔐 Header authentication for easy access management to the API read endpoints
  • 🔐 Token authentication for create and update endpoints
  • 🪶 SQLite database support.
  • 🐘 Postgres database support
  • 🌐︎ FE ready made web application fork.recipes
  • 🔎 Search endpoints supporting pagination
  • 📋 Schedule Meal plan application
  • 🛒 Add recipe ingredients to Shopping List
  • 🤖 AI Scrape page to recipe (scrape functionality that save a recipe by given a valid url)
  • 🤖 AI Generate recipe from a given ingredients (returns valid links with the generated recipes)
  • 🤖 AI Translate recipe to number of languages 🈹️
  • 🤖 AI Generate Recipe to Audio file (English language recipes only)
  • 🛢️ Export full database snapshot for the current state with media files

Documentation

You can sneek peek into the documentation of the API.
By default the installation is without SSL you can follow the instructions how to enable it.

Docker image

( must be used with nginx folder and .env file together to work)

  • amd64 image
docker pull mikebgrep/forkapi:latest
  • arm64 image
docker pull mikebgrep/forkapi:arm64

Admin panel

admin

Front End application

You can benefit from already build dockerized FE web application fork.recipes.That can be deployed together with the API. All instructions are added in the documentations ➡ docs

License

This project is licensed under the BSD 3-Clause License.

It includes third-party components licensed under the Apache License 2.0.

Sponsor this project

Packages

No packages published

Contributors 2

  •  
  •  

Languages