cookbook

cookbook

Web app to create, store and manage recipes, shopping lists and meal planner

Getting Started

The backend server has the following dependencies:

• PostgreSQL database
• S3 compatible storage for images
• OIDC IDP (Auth0 is supported currently)
• ENV variables for configuration

The following ENV variables are required:

Development

The code can be run locally by providing environment variables locally. There is no requirement for working S3 or OIDC credentials. A local database can be created with Docker.

foo@bar:~/cookbook$ docker run -d --name cookbook_db \
                    -e POSTGRES_DB=<databasename> \
                    -e POSTGRES_USER=<username> \
                    -e POSTGRES_PASSWORD=<password> \
                    -p 5432:5432 \
                    postgres

API docs are provided as Swagger docs. These are generated from endpoint annotations. To update the docs, make sure swag is installed:

foo@bar:~/cookbook$ go install github.com/swaggo/swag/cmd/swag@latest

update the docs with the swag init command:

foo@bar:~/cookbook$ swag init --parseDependency -g main.go