Matrix client for KaiOS

Farooq Karimi Zadeh 76afae3577 Merge branch 'master' of https://github.com/farooqkz/chooj 1 year ago
.github 45663be1a6 changing room of git updates 2 years ago
config f4020dac58 fix CSP 2 years ago
fixtures 57733b4803 Initial commit from Create Inferno App 2 years ago
public e2cb30000a C -> c and logo 1 year ago
scripts 24079a2e7c forgotten commit 2 years ago
src 81a7ad9006 another bug fix 1 year ago
.gitignore 9cd9d08ef4 adding dist/ 2 years ago
README.md 76afae3577 Merge branch 'master' of https://github.com/farooqkz/chooj 1 year ago
package.json 9b440c74a0 up? 1 year ago
yarn.lock 45a2ac32f4 matrix-js-sdk -> v15.x.x 2 years ago

README.md

Chooj

Matrix client for KaiOS with VoIP call support

The project is inactive because I must spend my time on projects which make me real money. But if anyone is interested in sponsoring, I would love to continue working on the project.

![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/farooqkz/chooj/Build/master) ![Chat on Matrix](https://img.shields.io/matrix/chooj:mozilla.org.svg?server_fqdn=mozilla.modular.im) [![CodeFactor](https://www.codefactor.io/repository/github/farooqkz/chooj/badge)](https://www.codefactor.io/repository/github/farooqkz/chooj) [![DeepScan grade](https://deepscan.io/api/teams/15094/projects/18237/branches/443145/badge/grade.svg)](https://deepscan.io/dashboard#view=project&tid=15094&pid=18237&bid=443145) ![Lines of code](https://img.shields.io/tokei/lines/github/farooqkz/chooj) ![GitHub repo size](https://img.shields.io/github/repo-size/farooqkz/chooj) ![GitHub all releases](https://img.shields.io/github/downloads/farooqkz/chooj/total) ![GitHub Repo stars](https://img.shields.io/github/stars/farooqkz/chooj?style=social) ![Licence badge](https://img.shields.io/badge/licence-GPLv3-yellow) ![KaiOS badge](https://img.shields.io/badge/KaiOS-2.5%2B-%236f02b5)

This is a free(open source) software Matrix client for KaiOS which is going to support VoIP calls. Perhaps voice call is already working, in this case please send a Pull Request to update this README.

Part of this project is done through crowdfunding. About 100 dollars was donated so that I could buy a Nokia 800 Tough and start the project.

Check related BananaHackers blog posts for more information.

What does work so far?

  • Login process with password works(manually or by scanning a QR code)
  • Chatting works in all rooms. Partially, however.
  • Voice call partially works.
  • Very experimental and unreliable push notification support which you can enable it in Settings
  • The Cow says "Please wait" to you kindly :))

How to help?

  • Create an issue and report a bug
  • Open a Pull Request and implement some wanted feature or fix some bug
  • Donate to me with cryptocurrency or hardware(Contact me for any of those)
  • Tell others about Chooj
  • Idle in Chooj's Matrix room and help others when necessary
  • Solve one of the issues especially creating Chooj a logo
  • Get Farooq something in his wish list
  • ...

Matrix chatroom for Chooj

This project has got a Matrix room. See badges.

Nightly builds

  • You can download and sideload ZIP for each time I push stuff from here.
  • NEW! OmniSD builds are available there, too!
  • Thanks to hashbang which let's me host stuff there.
  • Old ZIPs will be deleted after a some time.
  • Please allow a few minutes after each commit and the file will show up there.

NOTE: While I try to test stuff before pushing but you might find some broken builds there. There is no automated test yet.

Device compatiblity

This app should work on all KaiOS versions(excluding 3.x). However it has been also tested on these devices:

  • Nokia 8110 4G(aka The BananaPhone)
  • Nokia 800 Tough
  • Alcatel Go Flip 3 4052W (related issue)
  • [Add your own device here]

How to build?

The production build is currently broken and you may only use development builds.

  • Install Node v12.x if you haven't
  • Install yarn if you haven't
  • yarn install in project's directory
  • yarn run devbuild to create a development build(faster build at the cost of heavier bundle)
  • Now you can sideload the application in build/ to your device.

You can check guides on how to prepare your device for sideloading stuff and development at the BananaHackers wiki and website linked below:

Why Github?

See this post

Why InfernoJS?

See this post

Why Matrix?

Matrix fans fill stuff here :D

Related BananaHackers blog posts

License

This project is free software under GNU GPLv3 and comes without any warranty from author(s) of the project.

These files however are under different license(s):

  • waiting.ogg: Downloaded from here under CC0