aurora
/
nextcloud-neon
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
A framework for building convergent cross-platform Nextcloud clients using Flutter.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
346 Commits
24 Branches
0 Tags
53 MiB
 
 
Tree: fdfb10884f
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'fdfb10884f'
${ noResults }
nextcloud-neon/packages/nextcloud
jld3103 0af7aa4644
specs,nextcloud: Allow unknow capability keys at every level 		2 years ago
..
lib specs,nextcloud: Allow unknow capability keys at every level 2 years ago
test tool,nextcloud: Add back overlay 2 years ago
.gitignore Initial commit 2 years ago
LICENSE Symlink BSD-3 licenses 2 years ago
README.md Update username 2 years ago
analysis_options.yaml nextcloud, tool: Generate client using dynamite 2 years ago
build.yaml dynamite,specs,nextcloud: Support additionalProperties 2 years ago
mono_pkg.yaml ci: Speedup 2 years ago
pubspec.yaml dynamite,nextcloud,neon: Implement CookieJar 2 years ago

README.md

nextcloud

A Nextcloud client written in Dart.

This client will become the replacement for https://github.com/provokateurin/dart-nextcloud at some point (See).

Installing

In the future this code will be available at https://pub.dev/packages/nextcloud, but for now you have to include it via git in your pubspec.yaml:

dependencies:
  nextcloud:
    git:
      url: https://github.com/provokateurin/nextcloud-neon
      path: packages/nextcloud
      ref: $COMMIT

You can either remove the ref or use a commit hash. It's not recommended to remove it, because then the version will be updated very often.

Development

Except for WebDAV all client code is generated using OpenAPI specs which can be found in the ../../specs/ folder.
Templates for these OpenAPI specs are generated from the Nextcloud codebase to make development easier.

To generate such a template take a look at ../../tool/generate-nextcloud.sh.
After you have generated a template, you need to fill it out. Some endpoints can or have to be discarded.

Then you start writing tests for the endpoints you added.
To easily inspect the responses for an endpoint, just set the type to string inside the schema blocks of the spec and let the output be printed in the tests.

Sometimes you will have to look at the source code of Nextcloud, because the API is not always intuitive. Make sure to check if there is any API documentation that can help you.