Skip to content

🐘 Mastodon client for Android, iOS and Desktop (JVM)

License

Notifications You must be signed in to change notification settings

JacquesSmuts/MastodonCompose

 
 

Repository files navigation

MastodonX

CC-BY license CI

A multiplatform Mastodon client written in Kotlin for the amazing androiddev.social community and everyone else who enjoys #Fediverse

[F-Droid] [Google Play] [Apple Appstore]


Getting started

The app is not published nor ready for use. Later on it will probably just be installed from any of the available sources.

Contribution

See our Contribution Guidelines

MVP Roadmap

Building an MVP with base functionality for Desktop and Android

Progress of MVP can be found here

  • Sign up
  • Sign in with credentials
  • Browse local timeline
  • Create a Toot!
  • Log out

MVP contributions

Before tons of developers pour in to start contributing, it would be nice to get the codebase into a stable working condition with some sort of consistent architecture and design. In order to do this it would be more optimal to limit the # of devs working on each task under the MVP roadmap. Each task can be picked up by a single dev who does the full end-to-end functionality. Or, 2-3 devs can split up the work by having one person pick up the data/api layer, one on android and one on desktop. This small group can act like it's own "sprint team" and collaborate closely to split up the work and coordinate efforts to avoid duplicating effort. Since only one person can be assigned an issue, that person can be the feature "lead" and the other 1-2 devs can add a comment to the issue as the other contributors.

Non-MVP contributions

There is plenty of other issues to work on outside of MVP and these can be started by any contributor. Please assign the issue to yourself for visibility. Alternatively, there can be contributions made that aren't code related.

  • Innovative ideas for possible features that don't exist in other existing clients that require discussion here
  • General question, gotchas and other discussions here
  • Create new Issues/Features for post MVP. (e.g. Material You support, animations, V2 functionality, migrations, etc)

License

MastodonX is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

MastodonX is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with MastodonX. If not, see https://www.gnu.org/licenses/.

About

🐘 Mastodon client for Android, iOS and Desktop (JVM)

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Kotlin 100.0%