Kanbana
- 0 ratings
Create boards to track users and projects from flat markdown files. Forked from Crepido.
Deploy this app to Linode with a free $100 credit!
Kanbana allows you to create boards to track users and projects from flat markdown files that are rendered as Kanban boards. Based on Crepido by @issmirnov.
Kanbana is easy to use! It uses flat Markdown files that every text editor can open
See demo.md or example.md for examples
$ git clone https://github.com/SrGMC/kanbana.git$ cd kanbana$ npm install$ npm runA server will start at port 3000.
You can change the port and cache time two ways:
-p <port>-c <cache time> (in minutes).PORT=<port>CACHE=<cache time> (in minutes).docker rundocker run \
-p 3000:3000 \
-v "$PWD/boards:/usr/src/app/boards" \
-v "$PWD/images:/usr/src/app/images" \
-v "$PWD/labels.css:/usr/src/app/assets/labels.css" \
srgmc/kanbanaThis command will start the container and mount $PWD/boards and $PWD/images inside it, so you can add images and boards. If you do not want to customize labels.css, remove -v "$PWD/labels.css:/usr/src/app/assets/labels.css" from the command.
version: "3"
services:
kanbana:
environment:
PORT: 3000 # Optional
CACHE: 10 # Optional, in minutes
image: srgmc/kanbana
ports:
- "3000:3000" # If PORT is changed, this must be changed too
volumes:
- "/path/to/boards:/usr/src/app/boards"
- "/path/to/images:/usr/src/app/images"
- "/path/to/labels.css:/usr/src/app/assets/labels.css" # Optional---
"name": "Kanbana",
"picture": "none"
---
# Headers
* [UI] Labels
* [1h] Timers
* [25m] [UI] Labels and timers
* [ ] Uncompleted task
* [x] Completed task
# Markdown
* **Bold**
* *Italic*
* `code`http://<server ip>:<port>/board/<board name> or http://<server ip>:<port>/board/<board name>.mdNote:
Header images can be used in three ways:
none: Don't display any images/images/path-to-images.png: Add images to the images directory and fetch them from Kanbana's serverhttps://example.com/example.png: Use an URL to fetch an external imagesExample:
<!-- No image -->
---
"name": "Kanbana",
"picture": "none"
---
<!-- Internal image -->
---
"name": "Kanbana",
"picture": "/images/image.png"
---
<!-- External image -->
---
"name": "Kanbana",
"picture": "https://example.com/example.png"
---To add labels and timers, use:
<!-- Labels -->
[Title] [labels]
<!-- Timers -->
[2d] 2 days
[3h] 3 hours
[30m] 30 minutesUsing tasks is easy too:
[ ] Uncompleted task
[x] Completed taskLabels can be customized using CSS
To create custom labels, edit assets/labels.css. A custom label follows this sintax: .label--<label name>.
For example, to create a Help needed label with yellow color, create the class:
.label--help-needed {
background-color: #ffd43b;
color: #000;
}and use the label
[help needed]
The MIT License (MIT)
Copyright (c) 2017 Álvaro Galisteo Copyright (c) 2014 Arshad Chummun
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Please login to review this project.
No reviews for this project yet.
Comments (0)
Please login to join the discussion on this project.