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

Uploaded Source

Built Distribution

chef_recipes-2.4.0-py3-none-any.whl (646.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: chef_recipes-2.4.0.tar.gz
  • Upload date:
  • Size: 636.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.6 Linux/6.10.9-200.fc40.x86_64

File hashes

Hashes for chef_recipes-2.4.0.tar.gz
Algorithm Hash digest
SHA256 e2116ec1beb2cb71c82bbb0ae81b9ca42d0067107391949ca248bff73ff5789c
MD5 757c968dab54e59afc6e067c17b53f4a
BLAKE2b-256 5cac2119ace710ad160283553ae071d0874d628522c34e1251f7d52f563aebb4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: chef_recipes-2.4.0-py3-none-any.whl
  • Upload date:
  • Size: 646.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.6 Linux/6.10.9-200.fc40.x86_64

File hashes

Hashes for chef_recipes-2.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bc9c76061ab2bd0fee4a7a781c18421be18c5eb0659341765d5b7ffc47fd0f49
MD5 a11323d256e7e0453433030fed456ed9
BLAKE2b-256 5ce7536589e5b3f62db079643b8221386531f89721acf4b929ff33d1f632f990

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