diff options
author | Bernhard Posselt <dev@bernhard-posselt.com> | 2016-03-26 22:26:01 +0100 |
---|---|---|
committer | Bernhard Posselt <dev@bernhard-posselt.com> | 2016-03-27 14:53:29 +0200 |
commit | 04c1c8d3bd216a2195668cb06797079802c4fe44 (patch) | |
tree | 6e8ca32f2be56788f362eba68faddc69c84a2dca /README.md | |
parent | f2181c00552a0d79b9c6fac54fe416b8a5b307f4 (diff) |
add common makefile, make it possible to run tests and build package without installing global libs, enhance travis build file to also run php tests, add dev docs
fix indention
fix copyright
exclude gulpfile from appstore build
also generate coverage when phpunit exsits in path
remove breaking codecov from test
run codecov after success, use previous make package
run test suite instead of build
try without sudo
another try without sudo
switch from mariadb to mysql
mysql server seems to be present out of the box
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 46 |
1 files changed, 43 insertions, 3 deletions
@@ -1,4 +1,4 @@ -# ownCloud Contacts +# ownCloud Contacts [![irc](https://img.shields.io/badge/irc%20channel-%23owncloud--contacts%20on%20freenode-blue.svg)](https://webchat.freenode.net/?channels=owncloud-contacts) [![Build Status](https://scrutinizer-ci.com/g/owncloud/contacts/badges/build.png?b=master)](https://scrutinizer-ci.com/g/owncloud/contacts/build-status/master) @@ -9,7 +9,7 @@ **A contacts app for [ownCloud](https://owncloud.org).** -This is the new contacts app that has replaced the [old contacts app](https://github.com/owncloudarchive/contacts) with ownCloud 9.0, and is only the frontend for the new CardDAV-Backend which has moved into the [ownCloud Core](https://github.com/owncloud/core). +This is the new contacts app that has replaced the [old contacts app](https://github.com/owncloudarchive/contacts) with ownCloud 9.0, and is only the frontend for the new CardDAV-Backend which has moved into the [ownCloud Core](https://github.com/owncloud/core). ![](https://raw.githubusercontent.com/owncloud/screenshots/master/contacts/contacts.png) @@ -17,9 +17,49 @@ This is the new contacts app that has replaced the [old contacts app](https://gi - [Thomas Müller](https://github.com/DeepDiver1975) - [Hendrik Leppelsack](https://github.com/Henni) -- [Jan-Christoph Borchardt](https://github.com/jancborchardt) +- [Jan-Christoph Borchardt](https://github.com/jancborchardt) - [Alexander Weidinger](https://github.com/irgendwie) - [Tom Needham](https://github.com/tomneedham) If you’d like to join, just go through the [issue list](https://github.com/owncloud/contacts/issues) and fix some. :) + + +## 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 + + +## Publish to App Store + +First get an account for the [App Store](http://apps.owncloud.com/) then run: + + make appstore + +The archive is located in build/artifacts/appstore and can then be uploaded to the App Store. + +## 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 |