Skip to content

YanceyOfficial/kai

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

77 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kai(甲斐)

Code Style PRs Welcome Node Twitter

Flashcards APP using AI for learning words.

Word Word Explanation Spilt Combine Single Choice

Introduction

Gathering words that you can't recognize and using AI to generate their Chinese explanation, phonetic notation, examples, and quizzes. If you can't recognize them by learning more times, Kai can sync them to the challenging words folder, and just learn them repeatedly until you totally recognize them.

Kai-monorepo is the repository for the CMS and backend.

To start developing Kai

We have chosen React Native as our cross-platform base. Please follow their instruction to make sure that it is globally installed on your system.

  1. Install Node.js dependencies: npm i
  2. Install iOS pod: npx pod-install
  3. To start the development server, you can execute npx react-native run-ios

Environment Variables

KEYCLOAK_ISSUER=<YOUR_KEYCLOAK_ISSUER>
KEYCLOAK_CLIENT_ID=<YOURKEYCLOAK_CLIENT_ID>
KEYCLOAK_LOGOUT_URL=<YOUR_KEYCLOAK_LOGOUT_URL>
SENTRY_DSN=<YOUR_SENTRY_DSN>
SERVICE_URL=<YOUR_SERVICE_URL>

Contributing

The main purpose of this repository is to continue to evolve Kai, making it faster and easier to use. Development of Kai happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Kai.

Kai has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Kai.

Good Issues

Please make sure to read the Issue Reporting Checklist before opening an issue. Issues not conforming to the guidelines may be closed immediately.

License

Kai is licensed under the terms of the MIT licensed.

About

Flashcards with AI for learning words.

Resources

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published