Skip to content

kumo01GitHub/keisetsu-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

keisetsu Docs

Available languages:

PRs Welcome License: MIT

This is the documentation hub for the overall design intent and operational policy of keisetsu.

keisetsu-docs is a central place to manage cross-repository specifications, operational rules, and update procedures for all keisetsu implementations (publisher / database / mobile).

  • Clarifies the responsibilities of each repository
  • Documents distribution and validation flows independently from implementation
  • Maintains common decision criteria for specification changes

Concept

keisetsu is an open-source flashcard app that makes learning data storage and distribution routes public, allowing users to own and use their own learning materials.

  • Goal
    • Create an environment where anyone can learn with just a smartphone
  • Motivation
    • Solve existing issues such as data being private, online dependency, and unclear update routes
  • Advantages
    • All specifications, data, and distribution flows are public and transparent
    • OSS: anyone can update and use the data for free
  • Approach
    • Separate creation (publisher), distribution (database), and usage (mobile) for easy updates and reuse
    • Use a public schema for data structure, a public catalog for distribution routes, and an offline-capable app for learning

User Guide

How to use the keisetsu mobile app

  1. Install the Expo Go app on your smartphone.
  2. Scan the QR code to launch the keisetsu app.

Expo QR

You can start using the keisetsu app immediately.

How to use the keisetsu web deck editor

  1. Access the keisetsu-publisher public page
  2. Create a new deck, or import CSV / existing kdb
  3. Edit cards and deck info (ID, title, language, etc.)
  4. Download the ZIP file
  5. Extract the downloaded ZIP and place the generated files in keisetsu-database, then submit an addition/edit request

Supported Languages

  • English (en)
  • Japanese (ja)

Developer Guide

For detailed repository structure, operational rules, and technical information, see DEVELOPER.md.

About

keisetsu 全体の設計意図と、各リポジトリの関係を整理するドキュメントハブです。

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors