Files
deck/README.md
Julius Haertl 1d966033ec Update javascript section in README
Signed-off-by: Julius Haertl <jus@bitgrid.net>
2017-03-05 13:53:05 +01:00

2.4 KiB

Deck

Build Status CodeCov Scrutinizer Code Quality Dependency Status

Deck is a kanban style organization tool aimed at personal planning and project organization for teams integrated with Nextcloud.

  • 📥 Add your tasks to cards and put them in order
  • 📄 Write down additional notes in markdown
  • 🔖 Assign labels for even better organization
  • 👥 Share with your team, friends or family
  • 🚀 Get your project organized

Deck - Manage cards on your board

💥 This is still alpha software: it may not be stable enough for production

Planned features

  • 📁 Attach files directly from your Nextcloud
  • 🌍 Share boards with the public
  • 📆 Integration with Nextcloud calendar and other apps
  • 💬 Comments integration
  • 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

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

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