https://github.com/bemacized/shirakamisrs

Open source, self-hostable SRS for studying Japanese vocabulary.
https://github.com/bemacized/shirakamisrs

angular japanese japanese-language japanese-study language-learning nestjs srs typescript vocabulary-learning

Last synced: about 1 year ago
JSON representation

Open source, self-hostable SRS for studying Japanese vocabulary.

• Host: GitHub
• URL: https://github.com/bemacized/shirakamisrs
• Owner: BeMacized
• License: gpl-3.0
• Created: 2020-12-21T19:06:22.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2021-08-27T11:58:20.000Z (over 4 years ago)
• Last Synced: 2025-01-29T10:27:53.439Z (about 1 year ago)
• Topics: angular, japanese, japanese-language, japanese-study, language-learning, nestjs, srs, typescript, vocabulary-learning
• Language: TypeScript
• Homepage: https://shirakamisrs.com
• Size: 3.31 MB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          


    

    


    


    Open source, self-hostable SRS for studying Japanese vocabulary.





    

    

    

    

    



This is the main repository for ShiraKamiSRS. It is an open source, self-hostable [Spaced Repetition System (SRS)](https://en.wikipedia.org/wiki/Spaced_repetition) specifically geared towards learning Japanese vocabulary, heavily inspired by [WaniKani](https://wanikani.com/).

Want to get started? A publicly hosted instance is available over at [shirakamisrs.com](https://shirakamisrs.com/)!

**Note:** Currently, ShiraKamiSRS is still in its very early stages. A lot of very basic/obvious functionality is still missing. Check out what is planned [here](#roadmap)!



    



## Features

The main highlights:

- :books: Learning your own vocabulary


  Build your own cards and sets.

- :keyboard: Built-in IME


  For easily typing hiragana and katakana.

- :houses: Completely [self-hostable](https://github.com/BeMacized/ShiraKamiSRS/wiki/Self-Hosting)


  For if you prefer running things on your own server.

- :rocket: [Set repositories](https://github.com/BeMacized/ShiraKamiSRS/wiki/Set-Repositories)


  Easily import pre-built sets. Anyone can host repositories to share sets!

- :safety_vest:	Importing/Exporting sets


  Easily back up your progress, or move your data to a different instance.

- :iphone: Mobile friendly interface


  Do your reviews on the go!

- :waning_crescent_moon: Built-in dark mode


  Join us on the dark side. We have kitties!

  

### Built With

ShiraKamiSRS has been built with [Angular](https://angular.io/) and [NestJS](https://nestjs.com/).

  

## Getting Started

- Just want to use ShiraKamiSRS?
Use the public version over at [shirakamisrs.com](https://shirakamisrs.com/)!

- Interested in self-hosting ShiraKamiSRS?
[Follow the guide](https://github.com/BeMacized/ShiraKamiSRS/wiki/Self-Hosting).

- Want to host your own set repository?
[Read the documentation](https://github.com/BeMacized/ShiraKamiSRS/wiki/Set-Repositories).

- Do you want to contribute to the default set repository?
Find it over at the [ShiraKamiSRS Public Set Repository](https://github.com/BeMacized/ShiraKamiSRS-Public).

## Roadmap

Currently, ShiraKamiSRS is still missing a lot of basic features. I probably have more things I still want to do than I could list here, but I do think it is important to list a few major ones so it is known they are still coming. In no particular order:

- User Settings


  Currently there is no way for users to manage their own settings. In the future, users should be able to change their account information such as their email, username, or avatar.

- User Management


  Especially for people who administer their own instance of ShiraKamiSRS, it would be useful to be able to manage their users. 

- Skipping/Ignoring lessons


  Sometimes it would be useful to ignore or skip a lesson, especially when there is some overlap between cards. Currently the only way to do this is to delete the card from your set. 

- User synonyms


  It would be useful if users could add their own synonyms, without having to make their changes part of the card. 

- Bug fixes


  There are still quite a few bugs, some of which I know about and some I don't. 

  

If you have any other features you would like to suggest, or bugs you found that need to be fixed, feel free to [submit an issue](https://github.com/BeMacized/ShiraKamiSRS/issues/new) or come talk over in the [Discord](https://discord.gg/dvsgnxWUr5)!

## Contributing

Do you want to contribute? Great! Additional help is always appreciated, whether it be building card sets for the public set repository, writing documentation, fixing bugs, or even implementing whole new features. If you have any questions, feel free to [submit an issue](https://github.com/BeMacized/ShiraKamiSRS/issues/new) or come talk over in the [Discord](https://discord.gg/dvsgnxWUr5)!

I currently don't really have any contribution guidelines, but I'm sure we can figure it out.

If you are looking to contribute in a technical way, have a look at [Setting up your development environment](https://github.com/BeMacized/ShiraKamiSRS/wiki/Setting-up-your-development-environment).

## License

ShiraKamiSRS is available under the [GNU GPL-3.0](https://github.com/BeMacized/ShiraKamiSRS/blob/develop/LICENSE) license.