75 lines
2.2 KiB
Markdown
75 lines
2.2 KiB
Markdown
# Deck
|
|
|
|
Deck is a kanban style project and personal management tool integrated with OwnCloud.
|
|
|
|
|
|
|
|
## Installation/Update
|
|
|
|
### Install from git
|
|
|
|
If you want to run the latest development version from git source, you need to clone the repo to your apps folder:
|
|
|
|
```
|
|
git clone https://github.com/juliushaertl/deck.git
|
|
cd deck
|
|
make
|
|
```
|
|
|
|
Please make sure you have installed the following dependencies:
|
|
* 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, only required if a package.json is placed inside the **js/** folder
|
|
|
|
## Developing
|
|
|
|
### PHP
|
|
|
|
### JavaScript
|
|
Run javascript watch ```make watch```
|
|
|
|
|
|
|
|
## 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, only required if a package.json is placed inside the **js/** folder
|
|
|
|
The make command will install or update Composer dependencies if a composer.json is present and also **npm run build** if a package.json is present in the **js/** folder. The npm **build** script should use local paths for build systems and package managers, so people that simply want to build the app won't need to install npm libraries globally, e.g.:
|
|
|
|
**package.json**:
|
|
```json
|
|
"scripts": {
|
|
"test": "node node_modules/gulp-cli/bin/gulp.js karma",
|
|
"prebuild": "npm install && node_modules/bower/bin/bower install && node_modules/bower/bin/bower update",
|
|
"build": "node node_modules/gulp-cli/bin/gulp.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
|