From 75f0d3c093de01365f85e8e3035291d9a9a8c889 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?John=20Molakvo=C3=A6=20=28skjnldsv=29?= Date: Tue, 10 Jul 2018 18:40:59 +0200 Subject: Vue cleanup and init MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: John Molakvoæ (skjnldsv) --- README.md | 81 ++++++++++++--------------------------------------------------- 1 file changed, 15 insertions(+), 66 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index f795bce4..62cd4009 100644 --- a/README.md +++ b/README.md @@ -1,74 +1,23 @@ -# Nextcloud Contacts +# contacts -![Downloads](https://img.shields.io/github/downloads/nextcloud/contacts/total.svg) -[![irc](https://img.shields.io/badge/IRC-%23nextcloud--contacts%20on%20freenode-blue.svg)](https://webchat.freenode.net/?channels=nextcloud-contacts) -[![Build Status](https://travis-ci.org/nextcloud/contacts.svg?branch=master)](https://travis-ci.org/nextcloud/contacts) -[![Code coverage](https://img.shields.io/codecov/c/github/nextcloud/contacts.svg?maxAge=2592000)](https://codecov.io/gh/nextcloud/contacts/) +> A contacts app for Nextcloud. Easily sync contacts from various devices, share and edit them online. -**A contacts app for [Nextcloud](https://nextcloud.com). Easily sync contacts from various devices with your Nextcloud and edit them online.** +## Build Setup -![](https://raw.githubusercontent.com/nextcloud/screenshots/master/apps/Contacts/contacts.png) +``` bash +# set up and build for production +make -## Why is this so awesome? +# install dependencies +make dev-setup -* :rocket: **Integration with other Nextcloud apps!** Currently Mail and Calendar – more to come. -* :tada: **Never forget a birthday!** You can sync birthdays and other recurring events with your Nextcloud Calendar. -* :busts_in_silhouette: **Sharing of Adressbooks!** You want to share your contacts with your friends or coworkers? No problem! -* :see_no_evil: **We’re not reinventing the wheel!** Based on the great and open SabreDAV library. +# build for dev and watch changes +make watch-js -## Installation +# build for dev +make build-js -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. +# build for production with minification +make build-js-production +``` -## Support - -If you need assistance or want to ask a question about Contacts, you are welcome to [ask for support](https://help.nextcloud.com) in our Forums or the [IRC-Channel](https://webchat.freenode.net/?channels=nextcloud-contacts). 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](https://github.com/nextcloud/server) for help! - -## Maintainers: - -- [Hendrik Leppelsack](https://github.com/Henni) -- [Jan-Christoph Borchardt](https://github.com/jancborchardt) -- [John Molakvoæ](https://github.com/skjnldsv) - -If you'd like to join, just go through the [issue list](https://github.com/nextcloud/contacts/issues) and fix some. :) - -### Nightly builds - -Instead of setting everything up manually, you can just [download the nightly builds](https://nightly.portknox.net/contacts/?C=M;O=D) 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](https://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](http://phpunit.de/getting-started.html) and use the configurations directly: - - phpunit -c phpunit.xml - -or: - - phpunit -c phpunit.integration.xml - -for integration tests -- cgit v1.2.3