Skip to content

ErliSoares/kaiteki

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kaiteki

A 快適 (kaiteki) Fediverse client for microblogging instances, made with Flutter + Dart.

Currently Kaiteki is still in a proof-of-concept/alpha stage, with simple Mastodon/Pleroma and Misskey support, future backends could follow. See "What's working, what's missing?".

Aims and goals of this project

Kaiteki's mission is to support every Fediverse backend, OS platform and end user.

Kaiteki is built with Flutter, which has seen major progress in shipping to a wide range of devices, from mobile to desktop and the web.

The development of Kaiteki tries to support major (and in future minor) Fediverse backends, while not compromising on features.

We'll stay neutral and objective to every use case and view of every end user and try to give them the most comfortable and customizable Fediverse client.

Kaiteki tries to be community-driven with polls and opinions fetched from its creator, while also privacy-respecting. This means to also reject proprietary services and prefer everything to be transparent. An example of this is the rejection of Google's Firebase Cloud Messaging (FCM/GCM, which is being needlessly shoved in everyone's face by everyone else) in favor of a Flutter package called flutter_local_notifications. Another example is user's voicing disagreement over using error analytics like Sentry, which has been noted and will be avoided.

Screenshots (outdated)

Welcome page Login page Pleroma timeline Misskey timeline About page

Platforms & Releases<>

If you want to try out Kaiteki, there are automatic builds available for use.

Please still note, that Kaiteki is still in development. I don't take gurantee that everything works.

Platform Build status Link
Web Visit web version
Windows Check build artifacts
Linux Check build artifacts
Android No CI/CD available yet (See issue #2)
iOS Not supported
macOS Not supported

I'm thinking about packaging Kaiteki for my Linux, GNU/Linux, *nix distrobution

That's great! Before anything though, avoid trying to package Kaiteki if your package repository requires self-compiling.

While Kaiteki's source code is static and transparent, the Dart/Flutter SDK is not. I have heard several stories about it being difficult near to impossible to compile on your own (because it's self-updating, etc).

My hands are bound on that one and you have to accept pre-made binaries, unless you manually compile. Sorry :(

What's working, what's missing?

Currently Kaiteki only allows viewing timelines. Estimated, most important API calls for Misskey, Pleroma/Mastodon are already implemented, but lack proper internal adapter design, alongside their user interface.

Contributing

I'm happy about any feedback or contribution you have.

Since I am inexperienced with large scale projects, I have nothing against contributors, PRs, questions and anything in-between.

If you have questions you can reach me anywhere on my contact page (preferrably over email), you can also comment under issues that you want to get assigned to and want to work on.

Compiling Kaiteki

Depending on your platform you might have to take extra steps. See this page for steps on compiling for desktop, and this page for steps on compiling for web.

flutter upgrade # upgrade flutter to its latest version
flutter pub get # get packages

# run (debug)
flutter run
# or build (release)
flutter build apk
flutter build windows
flutter build linux
flutter build web
# and so on...

About

A cross-platform Fediverse client for micro-blogging services written in Flutter/Dart.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Dart 85.4%
  • C++ 5.8%
  • C# 4.4%
  • CMake 3.7%
  • C 0.4%
  • HTML 0.3%