Stapel

A simple platform to share and authorize Anki Decks.
Explore a live version »

Report Bug · Request Feature

Getting started

Important

The authentication of users is NOT handled by this application. Make sure to secure the /login route e.g. on a reverse proxy level

Deployment via docker-compose

services:
  stapel:
    image: ghcr.io/fachschaftmathphysinfo/cards:latest
    ports:
      - 8080:8080
    env_file: .env
    volumes:
      - ./data:/app/storage

Environment Variables

Required for Production environment

Key	Description	Example
PUBLIC_URL	Domain under which stapel is deployed	https://stapel.example.com
SMTP_HOST	E-Mail provider	smtp.example.com
SMTP_USER	The user to log into the SMTP Server	alice@example.com
SMTP_PASSWORD	The password to log into the SMTP Server	-
SMTP_PORT	The port of your SMTP Server	465
NOTIFICATION_FROM_ADDRESS	Address from which mails are send	stapel@example.com
NOTIFICATION_TO_ADDRESS	Address which gets notified about new decks	alice@example.com

Development

Build

cp .env .env.local
docker compose build
docker compose up -d && docker compose logs -f

• Frontend: localhost:8080
• API: localhost:8080/graphql
• GraphQL Playground: localhost:8080/playground

Frontend

cd frontend
npm i
npm run dev

Backend

cd server
go generate ./...
ENV=Development go run server.go

Contributions

1. create an issue
2. from this issue create a branch and work on it
3. create a pull request and tag one of the main contributors for a short review
4. sanfter Schulterklopfer ♡