Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/NoUmlautsAllowed/gocook

Alternative frontend to Chefkoch
https://github.com/NoUmlautsAllowed/gocook

Last synced: 3 months ago
JSON representation

Alternative frontend to Chefkoch

Awesome Lists containing this project

README

        

[![Go](https://github.com/NoUmlautsAllowed/gocook/actions/workflows/go.yml/badge.svg)](https://github.com/NoUmlautsAllowed/gocook/actions/workflows/go.yml)
[![Go Report Card](https://goreportcard.com/badge/github.com/NoUmlautsAllowed/gocook)](https://goreportcard.com/report/github.com/NoUmlautsAllowed/gocook)
[![codecov](https://codecov.io/gh/NoUmlautsAllowed/gocook/branch/main/graph/badge.svg?token=OO2AKXBRKU)](https://codecov.io/gh/NoUmlautsAllowed/gocook)

# :cook: GoCook

An alternative frontend to Chefkoch with a focus on privacy. Static CSS and
HTML only. Built with [Go](https://go.dev/)
and [Bulma](https://bulma.io/).

## What is this?

This is an alternative frontend to Chefkoch. The generated sites are static,
i.e. containing no JavaScript that runs on the client side.

All API and CDN traffic is proxied through GoCook, there is no communication
with any other hosts than GoCook itself.

## Hosted instances

-
-

## Build and Deployment

The easiest way to deploy this service is the standalone docker image.
Alternatively, building the application from source is possible too.

API and CDN requests are not cached for now. This may be a feature to be
added in the future.

### Docker

The official docker image is available at docker hub in the repository
[`noumlautsallowed/gocook`](https://hub.docker.com/r/noumlautsallowed/gocook).

Publish the port `8080` of the container locally:

```shell
docker run -d --name gocook -p 127.0.0.1:8080:8080 noumlautsallowed/gocook:latest
```

### Build from source

If you want to build this project from source, checkout the repository
locally and run the server.

Currently, only Go needs to be installed.

```shell
git clone [email protected]:NoUmlautsAllowed/gocook.git && cd gocook
npm i
npm run build
go build ./cmd/server
./server
```