Skip to main content

Personal recipe management app.

Project description

🍽️ Chef

A simple, customizable recipe management app.

A simple FastAPI + SQLAlchemy app + VueJS frontend. Frontend app is built and bundled together with the python build downloadable from PyPI -> the entire app can be run with a single command. It's also built as a single container and can be easily hosted (with little tweaks) on GCP Cloud Run.

Installation

curl https://raw.githubusercontent.com/xyzjonas/chef/master/install.sh | bash

or install the package yourself

pip install chef-recipes
chef --help

or run with docker:

docker run -p 8000:8000 -v ~/.chef:/chef/data scotch3840/chef:latest

Build & Development

Migrations

migrations are included in the build package, symbolic link to the alembic.ini is in the repository root

# schema changes
alembic revision --autogenerate -m "<... message ...>"

# upgrade the target database - accoring to $DATABASE_URI
alembic upgrade head

# ...or can be executed from the built script - i.e. without the sources
chef migrate-db

Build

  1. Poetry: build the standalone Python package
cd ./src/js/chef
npm run build
cd -
poetry build
poetry publish
  1. Build the docker image
docker build . -t scotch3840/chef
docker push scotch3840/chef

...or run on GCP using scotch3840/misc:chef-gcp image (PostgreSQL):

! second generation execution environment required.

  • BUCKET: name of your GCP/CloudStorage bucket.
  • MNT_DIR: target where the bucket will be mounted.
  • IMAGES_FOLDER: where the app will be looking for and storing uploaded images, has to be somewhere inside your bucket.
  • DATABASE_URI: specify your posgres or possibly put an sqlite file in the bucket as well.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chef_recipes-2.5.5.tar.gz (639.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chef_recipes-2.5.5-py3-none-any.whl (651.9 kB view details)

Uploaded Python 3

File details

Details for the file chef_recipes-2.5.5.tar.gz.

File metadata

  • Download URL: chef_recipes-2.5.5.tar.gz
  • Upload date:
  • Size: 639.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.7 Linux/6.15.10-200.fc42.x86_64

File hashes

Hashes for chef_recipes-2.5.5.tar.gz
Algorithm Hash digest
SHA256 f104b8f0cf6a378a95d89ffaf7be3a90339021e1937a01bb1cf3c29419a72a06
MD5 6e1438e153a68af0cbacaf487ae3b4a2
BLAKE2b-256 9f4254f9be095c5462505cd7581677182415c056e8b8309fcc68a9dea4f72c96

See more details on using hashes here.

File details

Details for the file chef_recipes-2.5.5-py3-none-any.whl.

File metadata

  • Download URL: chef_recipes-2.5.5-py3-none-any.whl
  • Upload date:
  • Size: 651.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.13.7 Linux/6.15.10-200.fc42.x86_64

File hashes

Hashes for chef_recipes-2.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 fe744c7b830fa262dc0c015ab3d7ea5272d311b5b998c30dae5e9053e5201402
MD5 9e8d873cffa003f4601272eb4dcf8abf
BLAKE2b-256 f05527716fa37784d49efb7051f6ca87723c2b8679466df7daff622c7944397c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page