Roba no hashi

From the German word "Eselsbrücke" meaning mnemonic.

This App allows users to lookup Radicals, Kanji and Vocabulary with mnemonics to aid learning. The difference from something like WaniKani is that users can upload their own menmonics and share with a community.

The app currently runs on web here: robanohashi.org

API documentation: api.robanohashi.org/docs/index.html

Redis schema

Authentication

Authentication is handled entirely by Firebase. This api only validates the JSON web token for endpoints that require it.

Development

For development I suggest to start a redis docker container.

docker run -d \
  --name redis \
  -p 6379:6379 \
  -p 8001:8001 \
  -v "$(pwd)/data:/data" \
  redis/redis-stack:latest

Migrations

Migrations for the Redis instance are performed locally and the dump.rdb files are backed on S3. Create a new package in /cmd/<package> for the migration code.

Docs

Download the swag cli.

go install github.com/swaggo/swag/cmd/swag@latest

Run swag init to generate the files

Indices

Run go run ./cmd/indices to recreate indices

Deployment

docker build -t martingrzzler/robanohashi-api:latest .

docker push martingrzzler/robanohashi-api:latest

On the production server update individual docker swarm services:

docker service update --image martingrzzler/robanohashi-api:latest robanohashi_api

docker service update robanohashi_redis --force

Test

Integration tests:

Make sure to start an empty redis instance.

go test ./persist

Unit tests:

go test ./internal/utils

martingrzzler/robanohashi-backend