111 lines
4.9 KiB
Markdown
111 lines
4.9 KiB
Markdown
# Deck
|
|
|
|
[](https://travis-ci.org/nextcloud/deck) [](https://codecov.io/github/nextcloud/deck) [](https://scrutinizer-ci.com/g/nextcloud/deck/?branch=master) [](https://www.versioneye.com/user/projects/58ad558f4ca76f004ed475b3) [](https://webchat.freenode.net/?channels=nextcloud-deck)
|
|
|
|
|
|
Deck is a kanban style organization tool aimed at personal planning and project organization for teams integrated with Nextcloud.
|
|
|
|
- :inbox_tray: Add your tasks to cards and put them in order
|
|
- :page_facing_up: Write down additional notes in markdown
|
|
- :bookmark: Assign labels for even better organization
|
|
- :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
|
|
|
|
This app is supposed to work on Nextcloud version 11 or later.
|
|
|
|
### Install latest release
|
|
|
|
You can download and install the latest release from the [Nextcloud app store](https://apps.nextcloud.com/apps/deck)
|
|
|
|
### 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/nextcloud/deck.git
|
|
cd deck
|
|
make install-deps
|
|
make
|
|
```
|
|
|
|
Please make sure you have installed the following dependencies: `make, which, tar, npm, curl`
|
|
|
|
### Install the nightly builds
|
|
|
|
Instead of setting everything up manually, you can just [download the nightly builds](https://download.bitgrid.net/nextcloud/deck/nightly/) instead. These builds are updated every 24 hours, and are pre-configured with all the needed dependencies.
|
|
|
|
## Developing
|
|
|
|
### PHP
|
|
|
|
Nothing to prepare, just dig into the code.
|
|
|
|
### JavaScript
|
|
|
|
When `'debug'=>true` is set in your config.php files will get loaded automatically. Otherwise you need to ensure that `public/app.js` is generated by running `make` or `make watch` to regenerate it on every change.
|
|
Make sure you have installed the dependencies with ```make install-deps```.
|
|
|
|
### Running tests
|
|
You can use the provided Makefile to run all tests by using:
|
|
|
|
make test
|
|
|
|
|
|
|
|
## Contribution Guidelines
|
|
|
|
Please 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.
|
|
|
|
For more information please review the [guidelines for contributing](https://github.com/nextcloud/server/blob/master/CONTRIBUTING.md) to this repository.
|
|
|
|
### Apply a license
|
|
|
|
All contributions to this repository are considered to be licensed under
|
|
the GNU AGPLv3 or any later version.
|
|
|
|
Contributors to the Deck app retain their copyright. Therefore we recommend
|
|
to add following line to the header of a file, if you changed it substantially:
|
|
|
|
```
|
|
@copyright Copyright (c) <year>, <your name> (<your email address>)
|
|
```
|
|
|
|
For further information on how to add or update the license header correctly please have a look at [our licensing HowTo][applyalicense].
|
|
|
|
### Sign your work
|
|
|
|
We use the Developer Certificate of Origin (DCO) as a additional safeguard
|
|
for the Nextcloud project. This is a well established and widely used
|
|
mechanism to assure contributors have confirmed their right to license
|
|
their contribution under the project's license.
|
|
Please read [developer-certificate-of-origin][dcofile].
|
|
If you can certify it, then just add a line to every git commit message:
|
|
|
|
````
|
|
Signed-off-by: Random J Developer <random@developer.example.org>
|
|
````
|
|
|
|
Use your real name (sorry, no pseudonyms or anonymous contributions).
|
|
If you set your `user.name` and `user.email` git configs, you can sign your
|
|
commit automatically with `git commit -s`. You can also use git [aliases](https://git-scm.com/book/tr/v2/Git-Basics-Git-Aliases)
|
|
like `git config --global alias.ci 'commit -s'`. Now you can commit with
|
|
`git ci` and the commit will be signed.
|
|
|
|
[dcofile]: https://github.com/nextcloud/server/blob/master/contribute/developer-certificate-of-origin
|
|
[applyalicense]: https://github.com/nextcloud/server/blob/master/contribute/HowToApplyALicense.md
|