Kummerkasten

A software to collect feedback in educational groups and institutions

Caution

Due to a lack of resources (servers for testing and humans for coding) this project is kind of paused. I will try to get back during late August, where the roadmap will include building a more robust testing foundation and focusing more on usability rather than aesthetics.

Quick Start

A quickstart guide can be found in our wiki. You can also find a more detailed explanation of the configuration options there. We will shortly add guides for users and admins on how the software itself works - although we feel it its fairly intuitive.

Development

Frontend

Switch into the frontend directory and run

npm i
npm run generate
npm run dev

Backend

After installing general golang and dependencies run

cp .env .env.local

and fill out the configurations as desired. Afterwards run:

cd server
export $(cat ../.env.local)
docker compose up -d
go generate ./...
go run server.go

now the frontend and api are available at port 8080

Testing

We provide E2E tests in frontend/cypress, to use them run

cd frontend
npm run test