CHEF - Cooking Helper for Everyone's Fridge

Kieran Knowles, 2023-2024

Installation

This project requires Node.js to be installed on your machine. You can download it here.

A setup script is provided to install all dependencies, set up the app, and run it. To run it, simply run the following command:

cd app
sudo ./setup.sh

After setup, the app will be running on port 3000 of your machine.

The following environment variables can be passed to the backend to configure its behaviour:

Variable	Description	Default
`PORT`	The port to run the server on	`3000`
`SETUP_LOG_FILE`	The file to log setup output to	`working_data/setup.log`
`SETUP_CSV_FILE`	The file to read the dataset from	`working_data/full_dataset.csv`
`RUNTIME_LOG_FILE`	The file to log runtime output to	`working_data/chefbackend.log`
`PORT`	The port to run the server on	`3000`
`DATABASE_PATH`	The path to the database file	`working_data/chefdatabase.db`
`MIN_LOG_LEVEL`	The minimum log level to log	`info`
`SECRET`	The secret to use for JWTs	n/a
`TOKEN_VALIDITY`	The valid duration of JWTs in seconds	`3600`

Name		Name	Last commit message	Last commit date
Latest commit History 768 Commits
.github/workflows		.github/workflows
.vscode		.vscode
app		app
cspell		cspell
report		report
.chktexrc		.chktexrc
.eslintrc.yml		.eslintrc.yml
.gitignore		.gitignore
.jscpd.json		.jscpd.json
.mega-linter.yml		.mega-linter.yml
.stylelintrc.json		.stylelintrc.json
.yamllint.yml		.yamllint.yml
CHEFCookingHelperForEveryonesFridge.code-workspace		CHEFCookingHelperForEveryonesFridge.code-workspace
Project ideas.txt		Project ideas.txt
cspell.yml		cspell.yml
package-lock.json		package-lock.json
package.json		package.json
readme.md		readme.md