Update README.md
This commit is contained in:
58
README.md
58
README.md
@@ -1,11 +1,34 @@
|
|||||||
# Deck
|
# Deck
|
||||||
|
|
||||||
Deck is a kanban style project and personal management tool integrated with OwnCloud.
|
[](https://travis-ci.com/juliushaertl/deck-dev) [](https://codecov.io/github/juliushaertl/deck-dev) [](https://scrutinizer-ci.com/g/juliushaertl/apporder/?branch=master) [](https://raw.githubusercontent.com/juliushaertl/apporder/master/LICENSE)
|
||||||
|
|
||||||

|
Deck is a kanban style project and personal management tool integrated with Nextcloud.
|
||||||
|
|
||||||
|
- :inbox_tray: Add your tasks to cards and put them in order
|
||||||
|
- :page_facing_up: Write down additional notes in markdown
|
||||||
|
- :busts_in_silhouette: Share with your team, friends or family
|
||||||
|
- :rocket: Get your project organized
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
:boom: This is still alpha software: it may not be stable enough for production
|
||||||
|
|
||||||
|
### Planned features
|
||||||
|
|
||||||
|
- :file_folder: Attach files directly from your Nextcloud
|
||||||
|
- :earth_africa: Share boards with the public
|
||||||
|
- :calendar: Integration with Nextcloud calendar and other apps
|
||||||
|
- :speech_balloon: Comments integration
|
||||||
|
- :exclamation: Checkout the project milestones for more ...
|
||||||
|
|
||||||
## Installation/Update
|
## Installation/Update
|
||||||
|
|
||||||
|
This app is supposed to work on Nextcloud version 11 or later.
|
||||||
|
|
||||||
|
### Install latest release
|
||||||
|
|
||||||
|
Grab the latest release over here, extract it to your Nextcloud apps folder and enable the app.
|
||||||
|
|
||||||
### Install from git
|
### 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:
|
If you want to run the latest development version from git source, you need to clone the repo to your apps folder:
|
||||||
@@ -16,45 +39,26 @@ cd deck
|
|||||||
make
|
make
|
||||||
```
|
```
|
||||||
|
|
||||||
Please make sure you have installed the following dependencies:
|
Please make sure you have installed the following dependencies: `make, which, tar, npm, curl`
|
||||||
* 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
|
## Developing
|
||||||
|
|
||||||
### PHP
|
### PHP
|
||||||
|
|
||||||
|
Nothing to prepare, just dig into the code.
|
||||||
|
|
||||||
### JavaScript
|
### JavaScript
|
||||||
|
|
||||||
|
Install dependencies with ```make dev-setup```
|
||||||
|
|
||||||
Run javascript watch ```make watch```
|
Run javascript watch ```make watch```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Building the app
|
## Building the app
|
||||||
|
|
||||||
The app can be built by using the provided Makefile by running:
|
The app can be built by using the provided Makefile by running:
|
||||||
|
|
||||||
make
|
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
|
## Running tests
|
||||||
You can use the provided Makefile to run all tests by using:
|
You can use the provided Makefile to run all tests by using:
|
||||||
|
|||||||
Reference in New Issue
Block a user