moxxy/README.md

1.8 KiB

Moxxy

An experimental XMPP client that tries to be as easy, modern and beautiful as possible.

The code is also available on codeberg.

Screenshots

screenshots

Developing and Building

Clone using git clone --recursive https://github.com/Polynomdivision/moxxyv2.git.

In order to build Moxxy, you need to have Flutter set up. Due to not yet merged code in Flutter, you are required to use a version of 2.13.0-0.1.pre or greater. If you are running NixOS or using Nix, you can also use the Flake at the root of the repository by running nix develop to get a development shell including everything that is needed.

Before building Moxxy, you need to generate all needed data classes. To do this, run flutter pub get to install all dependencies. Then run flutter pub run build_runner run to generate state data classes and the database schemata. After that, run make data to generate the library list, the xmpp-providers list and the command and event classes. After that is done, you can either build the app with flutter build or just run the app in development mode with flutter run

After implementing a change or a feature, please ensure that nothing is broken by the change by running flutter test afterwards. Also make sure that the code passes the linter by running flutter analyze. This project also uses gitlint to ensure uniform formatting of commit messages.

A Bit of History

This project is the successor of moxxyv1, which was written in React Native and abandoned due to various technical issues.

License

See ./LICENSE.

Special Thanks

  • New logo designed by Synoh