Sorsay

We are a team of dedicated innovators working towards transforming the digital experience for the Khmer language. Our project, Sorsay, focuses on revolutionizing Khmer communication through technology. Join us in preserving the rich heritage of the Khmer script and making it universally accessible.

Project Overview

Sorsay is an initiative that enhances the Khmer typing experience, promotes the use of the language, and provides educational tools for typing practice. Our approach is data-driven, allowing for continuous improvement and refinement of our technology.

Objectives

Enhanced Khmer Typing: Streamlining the typing process with a keyboard that converts Romanized inputs into Khmer Unicode.
Promoting Language Usage: Encouraging the digital use of Khmer language by providing user-friendly solutions.
Educational Tools: Offering a fun, interactive typing game to help users improve their Khmer typing skills.
Data Improvement: Utilizing user data to enhance our keyboard and algorithm, aiding in the development of a comprehensive Khmer dictionary.

Technical Stack

Next.js
TypeScript
Firebase
Redux
Tailwind CSS

Roadmap

While the roadmap for Sorsay's future is currently under development, we are planning exciting features and improvements.

Project Phases

✅ Phase 1: Sorsay Keyboard Web Implementation We've developed a dedicated website for the Sorsay keyboard, providing an intuitive platform for users to engage with our innovative typing solution.

⏳ Phase 2: Interactive Typing Game & Community Engagement Development of an interactive typing game to promote faster typing Implementation of a leaderboard to encourage competition and track progress Integration of achievement badges to reward user milestones Feature for users to submit their quotes for the typing game Data collection mechanism to gather user typing statistics for analysis and improvement of the tool

💡 Phase 3: Comprehensive Khmer Dictionary Compiling a thorough dictionary for the Khmer language, incorporating romanized data for accessibility

📖 Phase 4: Native Keyboard fully Native keyboard on all devices, starting IOS and mac.

How to Contribute

Whether you're a developer, a designer, a linguist, or just someone enthusiastic about our mission, there are several ways you can contribute:

Development: Contribute to code, fix bugs, and implement new features. Check the issues tab for existing tasks or add new ones if you've identified a bug or enhancement not already on the list.

Design: Help us improve the user interface and experience for the Sorsay keyboard and the upcoming game.

Data: Assist in data collection, analysis, and management necessary for the typing game and dictionary compilation.

Testing: Use the Sorsay keyboard and game, then provide feedback or report any bugs you find.

Content: Contribute to the dictionary or submit inspirational quotes that others can type in the game.

Installation

To clone and run this application, you'll need Git and Node.js

Fork this repository and clone the project

  git clone https://github.com/Rinzyy/sorsay.git

Go to the project directory

  cd sorsay

Install dependencies

  npm install

Install .env and gloud.json You will need to set up your own .env.local for Google email contact and gcloud.json for Firebase.
Start the server

  npm run dev

Support

For support, questions, or conversations, join our Discord server (link coming soon). We're building a community of developers, users, and enthusiasts, and we'd love your input!

License

Sorsay is licensed under the GNU General Public License. See LICENSE for more information.

Acknowledgments

Khmer Language Resources

Changelog

20/10/2023 Initial release - Stay tuned for updates on new features, improvements, and fixes.

Rinzyy / sorsay