leosimetti / karakuli-backend

Karakuli backend

This is the server side of the application, written using FastApi.

Currently available at https://karakuli-backend.herokuapp.com/docs

Features:

1. Lesson types - Lessons are split into Radicals, Kanji, Words, Grammar.
2. Study lists - users are able to combine lessons into lists available to others.
3. SRS-reviews - users can add lessons from their current study list as perosnal reviews to study them later using SRS.
4. Jwt-authentication - authentication via jwt-token. To be used by the mobile app
5. Cookie-authentication - TBD

Available settings (env variables)

• JWT_SECRET_KEY - secret key used for authentication
• DB_HOST - database url (preferably use async protocols)
• BEKA_DB - self-hostefd database url (DB_HOST is used if not set)
• HOST_IP - the app IP
• PORT - the app port

DB schema (the image is clickable):

How to start:

Install python and run main.py

OR

Install Docker and run docker-compose up

karakuli-backend's Issues

ARCHITETIHCRA

https://drive.google.com/file/d/1PqZJxKiTkhssJBc7b_H9C9IGK4AMEv_P/view?usp=sharing