See [here](packages/app/README.md) for screenshots and other material regarding the app.
A framework for building convergent cross-platform Nextcloud clients using Flutter.
This repository not only contains the Neon app, but also a Nextcloud client written in Dart.
The client will replace https://github.com/provokateurin/dart-nextcloud which is an older unmaintained client I wrote some time ago.
The development of this app and client just started, there will be a lot of changes and new features coming soon.
Additional documentation is very much appreciated. If you find something that you think should be documented, please open an issue or pull request.
## Development and support
Either open an issue if you exactly know what you need or your problem is, otherwise please ask in Matrix.
The Matrix space is here: https://matrix.to/#/#nextcloud-neon:matrix.org.
There are separate rooms for the client and the app. If you don't know which channel you should use if you have a question, just use the app channel.
## Features
## Features
There are a lot of planned features that still need help. Go [here](https://github.com/provokateurin/nextcloud-neon/issues?q=is%3Aopen+is%3Aissue+label%3Afeature) and grab an issue to work on.
See [here](packages/app/README.md) for screenshots.
Even if a new feature is not listed yet, please open an issue.
- :heavy_check_mark: Supported
- :heavy_check_mark: Supported
- :rocket: Planned
- :rocket: Planned
@ -40,6 +26,43 @@ Even if a new feature is not listed yet, please open an issue.
| Talk | :rocket: |
| Talk | :rocket: |
| Tasks | :rocket: |
| Tasks | :rocket: |
## Problems with other clients and how this project tries to solve them
### Current problems with other clients
_Excerpt from my job application to Nextcloud:_
- There are many clients that are designed to run exclusively on a single platform or device type. They all have different code bases, which makes feature parity and maintenance much more difficult.
- The user experience and features differ significantly from platform to platform, which leads to frustration. This particularly affects mobile devices running Linux (e.g. postmarketOS). There is no suitable client on this platform at all. Using the desktop Linux client for file synchronization would probably work, but this platform still lacks almost all the features available on e.g. Android and the client is not made for mobile screens. Someone who uses Linux on their mobile device is likely also interested in Nextcloud, so the need for a solution is definitely there.
- Even on feature-rich platforms, features are spread across multiple apps (e.g. on Android), making it more complicated for the user who simply wants to get the most out of their Nextcloud server on their device.
### How Neon as a framework tries to solve them
This project uses OpenAPI specifications to generate all the necessary API client code.
This vastly reduces the developer efforts of writing a lot of boilerplate code and having to look at the PHP source code.
Most server APIs were not well or at all documented until now (there are some exceptions).
Based on this work a project at the Nextcloud company started for adopting OpenAPI to document the server APIs.
The OpenAPI specifications are generated completely automated from the source code (although some changes to the type annotations are required) and are validated with static analysis of the PHP code.
These efforts are not done yet, but this project basically became the front-line for testing the automatically generated specifications.
We use flutter because of its cross-platform capabilities.
To decrease the developer burden, a lot of useful widgets and utilities have been developed, so that they can be re-used.
Trying to make everything re-usable is a major goal of this project, as we want to close the gap between platforms and functionalities and make development of new clients and apps enjoyable and fast.
Developing a new Nextcloud client can be as easy as adding some UI and then necessary state management, everything else is taken care of for you.
## Development and support
We have a Matrix space where you can ask questions: https://matrix.to/#/#nextcloud-neon:matrix.org
- For APIs the nextcloud package provides the implementations. The dynamite generator generates the code using the OpenAPI specs.
- The main package is the neon package that provides widgets and functionality that is useful for building a Nextcloud client. It also manages the global state at runtime so that the app implementations do not have to manage things like multiple accounts for example.
- The individual apps are implemented as separate packages. Those depend on the neon framework and implement a few interfaces so that the neon framework can use them.
- On top of all that sits the app package that injects the relevant app implementations into the framework. It is possible to configure which app implementations should be included and how the app is branded.
A beautiful convergent cross-platform client for Nextcloud written in Flutter.
A beautiful convergent cross-platform client for Nextcloud written in Flutter.
## Install
## Install
You can build it yourself from source now, automatic build pipelines are being set up right now.
You can build it yourself from source or download it from the automatic build pipelines.
The app will be published on F-Droid and the Google Playstore later. See https://github.com/provokateurin/nextcloud-neon/issues/106 for the to-do list.
The app will be published on F-Droid, the Google Playstore and Flathub later on. See https://github.com/provokateurin/nextcloud-neon/issues/106 for the to-do list.
Kate
2 years ago
committed by
GitHub
