|Phyks (Lucas Verney) 73ae6d89f8 Update home screenshot||2 years ago|
|build||2 years ago|
|config||2 years ago|
|cuizin||2 years ago|
|migrations||2 years ago|
|screenshots||2 years ago|
|.babelrc||2 years ago|
|.editorconfig||2 years ago|
|.eslintignore||2 years ago|
|.eslintrc.js||2 years ago|
|.gitignore||2 years ago|
|.postcssrc.js||2 years ago|
|LICENSE.txt||2 years ago|
|README.md||2 years ago|
|package.json||2 years ago|
|requirements.txt||2 years ago|
Cuizin is a tool wrapping around Web Outside Of Browsers to help you sort and organize recipes you find online. You can also manually add new recipes.
More screenshots are available in the
Cuizin requires Python 3 and may not be compatible with Python 2.
$ git clone … # Clone this repository $ pip3 install -r requirements.txt # Install Python dependencies $ npm install # Install JS dependencies for the frontend $ npm run build # Build the JS dependencies
Ideally, Python dependencies should be installed in a virtual environment.
If you serve the app from a subdirectory (and not the root of your domain),
you might want to run
URL_PREFIX=/subdir/ npm run build instead of
build to use the correct path to call the API. Note that the trailing slash
python -m cuizin to run the built-in webserver. Conversely, you can use
WSGI to serve the application directly (
application variable is exported in
You can customize the behavior of the app by passing environment variables:
CUIZIN_HOSTto set the host on which the webserver should listen to (defaults to
CUIZIN_HOST=0.0.0.0to make it world-accessible.
CUIZIN_PORTto set the port on which the webserver should listen. Defaults to
CUIZIN_DEBUGto enable or disable the debug from Bottle (defaults to
WEBOOB_MODULES_PATHto set the path to the local clone of the Weboob modules. Default to using the
weboob-modulespackage installed by
pip(and which you should regularly update with
pip install --upgrade weboob-modules).
If you serve the app with a reverse proxy, you should serve the content of
cuizin/dist (static frontend files) directly, without passing it down to the
If you are updating the app, the database schema may have changed. There is a
set of migrations under the
migrations folder which is a set of standalone
scripts to run to update your database schema. Each script is named after the
commit it is handling.
All contributions are welcome, feel free to open a MR. Just in case, if you plan on working on some major new feature, please open an issue before to get some feedbacks.
All the code lies under
cuizin directory. Frontend code lies under
config folders at the root of this repository
are used for the frontend build.
Additionnally, you can use
make dev to spawn a development webserver to
serve the JS frontend and auto-update/auto-reload when you make changes. The
spawned JS server will be set up at
localhost:8081 and you should start the
backend Python server at
python -m cuizin along it.
You can simply open the app at
localhost:8081 and start developping, it will
automatically call the API from the
python -m cuizin process, on port
This software is released under an MIT License.