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.2.0.tar.gz (830.2 kB view details)

Uploaded Source

Built Distribution

chef_recipes-2.2.0-py3-none-any.whl (837.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chef_recipes-2.2.0.tar.gz
  • Upload date:
  • Size: 830.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.3 Linux/6.8.10-200.fc39.x86_64

File hashes

Hashes for chef_recipes-2.2.0.tar.gz
Algorithm Hash digest
SHA256 61f29bf8d85023e6ebc6bfd42d8914bb371ba804801ae023ff5ba3ab2189a714
MD5 cb36c9d13fe3386f8d598f3e6e463335
BLAKE2b-256 368235d0bd9439338744d82b4b51fef44f641f2ff7c9dbf407e349ec01785916

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chef_recipes-2.2.0-py3-none-any.whl
  • Upload date:
  • Size: 837.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.3 Linux/6.8.10-200.fc39.x86_64

File hashes

Hashes for chef_recipes-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 39e3662701186eb374b37b451cac8b9ef53fdc19ef0ce012a914a78ae3aeeea0
MD5 86a385abb61aa24c8ba58a7d7ef63b26
BLAKE2b-256 7261507201f053a057772c7cff3794a285415e35a64ed46cdea4d839fe7f9195

See more details on using hashes here.

Supported by

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