A framework for building convergent cross-platform Nextcloud clients using Flutter.
At the Nextcloud Conference 2023 there was a lightning talk summarizing the Neon framework: https://www.youtube.com/watch?v=MD3zlRHdSEw
Check out our contributing docs to get started with developing with Neon.
We have a lot of documentation from helping you set up your development environment to our guidelines. Please make sure to read them before starting to contribute.
The Neon project has three main goals:
The Neon project uses Dart and Flutter to help mobile client developers building apps. Flutter allows us to build convergent cross-platform clients that feel native. We are a 100% FOSS framework and do not rely on any proprietary libraries making it easy for developers to publish their apps in places like the F-Droid store. We provide a generated Nextcloud Dart client that is generated from the new OpenAPI specifications shipped with Nextcloud and is already being used by other Dart and Flutter projects. Gone are the days of looking at the PHP code and implementing an API client by hand which can be time-consuming and very error-prone. For more details on generating the OpenAPI specifications you can watch the following lightning talk from the Nextcloud Conference 2023: https://www.youtube.com/watch?v=lI9PrOOMLzE
We provide abstractions, common utilities and prebuilt UI components (called Widgets in Flutter) that can be re-used. This allows Neon to make developing a new Nextcloud client as easy as adding a few custom UI elements and the necessary state management, while everything else is already taken care of for you.
We encourage every client developer to contribute their app implementation back into Neon. This way the app developers can choose from a large set of clients to enable.
We have a Matrix space where you can ask questions: https://matrix.to/#/#nextcloud-neon:matrix.org
See here for screenshots.
App | Status |
---|---|
Dashboard | :white_check_mark: |
Files | :white_check_mark: |
News | :white_check_mark: |
Notes | :white_check_mark: |
Notifications | :white_check_mark: |
Talk | :construction: |
Activity | :rocket: |
Calendar | :rocket: |
Contacts | :rocket: |
Cookbook | :rocket: |
Cospend | :rocket: |
Deck | :rocket: |
Photos | :rocket: |
Tasks | :rocket: |
Platform | Progress |
---|---|
Android | :white_check_mark: |
iOS | :construction: |
MacOS | :construction: |
Linux | :white_check_mark: |
Windows | :rocket: |
Web | :white_check_mark: |
Check the example for instructions to try out the app.