README.md
1# Deck
2
3[](https://travis-ci.org/nextcloud/deck) [](https://codecov.io/github/nextcloud/deck) [](https://www.codacy.com/app/juliushaertl/deck?utm_source=github.com&utm_medium=referral&utm_content=nextcloud/deck&utm_campaign=Badge_Grade) [](https://scrutinizer-ci.com/g/nextcloud/deck/?branch=master) [](https://webchat.freenode.net/?channels=nextcloud-deck)
4
5
6Deck is a kanban style organization tool aimed at personal planning and project organization for teams integrated with Nextcloud.
7
8- Add your tasks to cards and put them in order
9- Write down additional notes in markdown
10- Assign labels for even better organization
11- Share with your team, friends or family
12- Integrates with the [Circles](https://github.com/nextcloud/circles) app!
13- Attach files and embed them in your markdown description
14- Discuss with your team using comments
15- Keep track of changes in the activity stream
16- Get your project organized
17
18
19
20### Mobile apps
21
22- [Nextcloud Deck app for Android](https://github.com/stefan-niedermann/nextcloud-deck) - It is available in [F-Droid](https://f-droid.org/de/packages/it.niedermann.nextcloud.deck/) and the [Google Play Store](https://play.google.com/store/apps/details?id=it.niedermann.nextcloud.deck.play)
23
24### 3rd-Party Integrations
25
26- [trello-to-deck](https://github.com/maxammann/trello-to-deck) - Migrates cards from Trello
27- [mail2deck](https://github.com/newroco/mail2deck) - Provides an "email in" solution
28- [A-deck](https://github.com/leoossa/A-deck) - Chrome Extension that allows to create new card in selected stack based on current tab
29-
30## Installation/Update
31
32This app is supposed to work on the two latest Nextcloud versions.
33
34### Install latest release
35
36You can download and install the latest release from the [Nextcloud app store](https://apps.nextcloud.com/apps/deck)
37
38### Install from git
39
40If you want to run the latest development version from git source, you need to clone the repo to your apps folder:
41
42```
43git clone https://github.com/nextcloud/deck.git
44cd deck
45make install-deps
46make build
47```
48
49Please make sure you have installed the following dependencies: `make, which, tar, npm, curl, composer`
50
51### Install the nightly builds
52
53Instead of setting everything up manually, you can just [download the nightly build](https://github.com/nextcloud/deck/releases/tag/nightly) instead. These builds are updated every 24 hours, and are pre-configured with all the needed dependencies.
54
55## Developing
56
57### PHP
58
59Nothing to prepare, just dig into the code.
60
61### JavaScript
62
63Deck requires running a `make build-js` to install npm dependencies and build the JavaScript code using webpack. While developing you can also use `make watch` to rebuild everytime the code changes.
64
65#### Hot reloading
66
67Enable debug mode in your config.php `'debug' => true,`
68
69Without SSL:
70```
71npx webpack-dev-server --config webpack.hot.js \
72 --public localhost:3000 \
73 --output-public-path 'http://localhost:3000/js/'
74```
75
76With SSL:
77```
78npx webpack-dev-server --config webpack.dev.js --https \
79 --cert ~/repos/nextcloud/nc-dev/data/ssl/nextcloud.local.crt \
80 --key ~/repos/nextcloud/nc-dev/data/ssl/nextcloud.local.key \
81 --public nextcloud.local:3000 \
82 --output-public-path 'https://nextcloud.local:3000/js/'
83```
84
85
86### Running tests
87You can use the provided Makefile to run all tests by using:
88
89 make test
90
91### Documentation
92
93The documentation for our REST API can be found at https://deck.readthedocs.io/en/latest/API/
94
95## Contribution Guidelines
96
97Please read the [Code of Conduct](https://nextcloud.com/community/code-of-conduct/). This document offers some guidance to ensure Nextcloud participants can cooperate effectively in a positive and inspiring atmosphere, and to explain how together we can strengthen and support each other.
98
99For more information please review the [guidelines for contributing](https://github.com/nextcloud/server/blob/master/.github/CONTRIBUTING.md) to this repository.
100
101### Apply a license
102
103All contributions to this repository are considered to be licensed under
104the GNU AGPLv3 or any later version.
105
106Contributors to the Deck app retain their copyright. Therefore we recommend
107to add following line to the header of a file, if you changed it substantially:
108
109```
110@copyright Copyright (c) <year>, <your name> (<your email address>)
111```
112
113For further information on how to add or update the license header correctly please have a look at [our licensing HowTo][applyalicense].
114
115### Sign your work
116
117We use the Developer Certificate of Origin (DCO) as a additional safeguard
118for the Nextcloud project. This is a well established and widely used
119mechanism to assure contributors have confirmed their right to license
120their contribution under the project's license.
121Please read [developer-certificate-of-origin][dcofile].
122If you can certify it, then just add a line to every git commit message:
123
124````
125 Signed-off-by: Random J Developer <random@developer.example.org>
126````
127
128Use your real name (sorry, no pseudonyms or anonymous contributions).
129If you set your `user.name` and `user.email` git configs, you can sign your
130commit automatically with `git commit -s`. You can also use git [aliases](https://git-scm.com/book/tr/v2/Git-Basics-Git-Aliases)
131like `git config --global alias.ci 'commit -s'`. Now you can commit with
132`git ci` and the commit will be signed.
133
134[dcofile]: https://github.com/nextcloud/server/blob/master/contribute/developer-certificate-of-origin
135[applyalicense]: https://github.com/nextcloud/server/blob/master/contribute/HowToApplyALicense.md
136
){kind=link}
){kind=link}
){kind=link}
){kind=link}
){kind=link}