Skip to content

Latest commit

 

History

History
74 lines (46 loc) · 3.42 KB

README.md

File metadata and controls

74 lines (46 loc) · 3.42 KB
Raw

Nextcloud Contacts

Downloads irc Build Status Code coverage

A contacts app for Nextcloud. Easily sync contacts from various devices with your Nextcloud and edit them online.

Why is this so awesome?

  • 🚀 Integration with other Nextcloud apps! Currently Mail and Calendar – more to come.
  • 🎉 Never forget a birthday! You can sync birthdays and other recurring events with your Nextcloud Calendar.
  • 👥 Sharing of Adressbooks! You want to share your contacts with your friends or coworkers? No problem!
  • 🙈 We’re not reinventing the wheel! Based on the great and open SabreDAV library.

Installation

In your Nextcloud, simply navigate to »Apps«, choose the category »Organization«, find the Contacts app and enable it. Then open the Contacts app from the app menu.

Support

If you need assistance or want to ask a question about Contacts, you are welcome to ask for support in our Forums or the IRC-Channel. If you have found a bug, feel free to open a new Issue on GitHub. Keep in mind, that this repository only manages the frontend. If you find bugs or have problems with the CardDAV-Backend, you should ask the guys at Nextcloud server for help!

Maintainers:

If you'd like to join, just go through the issue list and fix some. :)

Nightly builds

Instead of setting everything up manually, you can just download the nightly builds instead. These builds are updated every 24 hours, and are pre-configured with all the needed dependencies.

  1. Download
  2. Extract the tar archive to 'path-to-nextcloud/apps'
  3. Navigate to »Apps«, choose the category »Productivity«, find the Contacts app and enable it.

The nightly builds are provided by Portknox.net

Building the app

The app can be built by using the provided Makefile by running:

make

This requires the following things to be present:

  • make
  • which
  • tar: for building the archive
  • curl: used if phpunit and composer are not installed to fetch them from the web
  • npm: for building and testing everything JS

Running tests

You can use the provided Makefile to run all tests by using:

make test

This will run the PHP unit and integration tests and if a package.json is present in the js/ folder will execute npm run test

Of course you can also install PHPUnit and use the configurations directly:

phpunit -c phpunit.xml

or:

phpunit -c phpunit.integration.xml

for integration tests