1
0
Fork 0
mirror of https://github.com/nextcloud/android.git synced 2024-11-02 03:36:13 +01:00
nextcloud-android/README.md
Andy Scherzinger e3d57e7c42
Update SPDX header to reflect correct state
Resolves #12920

Signed-off-by: Andy Scherzinger <info@andy-scherzinger.de>
2024-04-30 12:18:45 +02:00

7.7 KiB

Nextcloud Android app 📱

REUSE status Build Status Codacy Badge Releases

Download from Google Play Get it on F-Droid

The Android client for Nextcloud. Easily work with your data on your Nextcloud.

App screenshots

Getting help ⛑️

Note: The section Known Problems / FAQs below may already document your situation.

If you need assistance or want to ask a question about the Android app, you are welcome to ask for support in the Nextcloud Help Forum. If you have found a probable bug or have an enhancement idea, feel free to open a new Issue on GitHub.

If you're not sure if something is a bug or a configuration matter (with your client, server, proxy, etc.), the Nextcloud Help Forum is probably the best place to start so that you can get feedback (you can always return here, after getting feedback there, to report a suspected bug).

Keep in mind, that this repository only manages the Android app. If you find bugs or have problems with the server/backend, you should use the Nextcloud Help Forum to ask for help or report the bug to the Nextcloud server team!

How to contribute 🚀

If you want to contribute to the Nextcloud Android client app, there are many ways to help whether or not you are a coder:

  • helping out other users on our forum at https://help.nextcloud.com
  • providing translations of the app on Transifex
  • reporting problems / suggesting enhancements by opening new issues
  • implementing proposed bug fixes and enhancement ideas by submitting PRs (associated with a corresponding issue preferably)
  • reviewing pull requests and providing feedback on code, implementation, and functionality
  • installing and testing pull request builds, daily/dev builds, or RCs/release candidate builds
  • enhancing Admin, User, or Developer documentation
  • hitting hard on the latest stable release by testing fundamental features and evaluating the user experience
  • proactively getting familiar with how to gather debug logs from your devices (so that you are prepared to provide a detailed report if you encounter a problem with the app in the future)

Contribution Guidelines & License 📜

GPLv2. All contributions to this repository from June, 16 2016 on are considered to be licensed under the AGPLv3 or any later version.

Nextcloud doesn't require a CLA (Contributor License Agreement). The copyright belongs to all the individual contributors. Therefore we recommend that every contributor adds following line to the header of a file, if they changed it substantially:

SPDX-FileCopyrightText: <year> <your name> <your email address>

Please read the Code of Conduct. This document offers some guidance to ensure Nextcloud participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other.

Please review the guidelines for contributing to this repository.

More information on how to contribute: https://nextcloud.com/contribute/

Start contributing 🛠️

Make sure you read SETUP.md and CONTRIBUTING.md before you start working on this project. But basically: fork this repository and contribute back using pull requests to the master branch. Easy starting points are also reviewing pull requests and working on starter issues.

Logs

Getting debug info via logcat 🔍

With a linux computer:

  • enable USB-Debugging in your smartphones developer settings and connect it via USB
  • open command prompt/terminal
  • enter adb logcat --pid=$(adb shell pidof -s 'com.nextcloud.client') > logcatOutput.txt to save the output to this file

Note: You must have adb installed first!

On Windows:

  • download and install Minimal ADB and fastboot
  • enable USB-Debugging in your smartphones developer settings and connect it via USB
  • launch Minimal ADB and fastboot
  • enter adb shell pidof -s 'com.nextcloud.client' and use the output as <processID> in the following command:
  • adb logcat --pid=<processID> > "%USERPROFILE%\Downloads\logcatOutput.txt" (This will produce a logcatOutput.txt file in your downloads)
  • if the processID is 18841, an example command is: adb logcat --pid=18841 > "%USERPROFILE%\Downloads\logcatOutput.txt" (You might cancel the process after a while manually: it will not be exited automatically.)
  • For a PowerShell terminal, replace %USERPROFILE% with $env:USERPROFILE in the commands above.

On a device (with root) 🔧

  • open terminal app (can be enabled in developer options)
  • get root access via "su"
  • enter logcat -d --pid $(pidof -s com.nextcloud.client) -f /sdcard/logcatOutput.txt

or

Note: Your device needs to be rooted for this approach!

Development version 🔨

Known Problems and FAQs

Push notifications do not work on F-Droid editions

Push Notifications are not currently supported in the F-Droid builds due to dependencies on Google Play services.

Remarks 📜

Google Play and the Google Play logo are trademarks of Google Inc.