phfsantos / kanban-board

A kanban board as an add-on to markdown files.

kanban-board

A simple kanban board to be used as an add-on to markdown files within markdown files in vscode.

About

The Kanban Board is an add-on to markdown files, allowing for a visual representation of tasks and progress directly within your repository. This project aims to integrate a Kanban-style board to enhance project management and workflow visualization. It can also be used in any website.

<kanban-board class="language-kanban-board" data="%7B%22columns%22%3A%5B%7B%22id%22%3A%221%22%2C%22title%22%3A%22Todo%22%2C%22items%22%3A%5B%7B%22id%22%3A%2219767%22%2C%22content%22%3A%22Fix%20bugs%22%7D%5D%7D%2C%7B%22id%22%3A%222%22%2C%22title%22%3A%22Doing%22%2C%22items%22%3A%5B%7B%22id%22%3A%2216079%22%2C%22content%22%3A%22Basic%20design%22%7D%5D%7D%2C%7B%22id%22%3A%223%22%2C%22title%22%3A%22Done%22%2C%22items%22%3A%5B%7B%22id%22%3A%2225152%22%2C%22content%22%3A%22Created%20repo%22%7D%5D%7D%5D%7D"></kanban-board>

Features

• Drag-and-Drop Interface: Easily move tasks between different stages of your workflow.
• Customizable Columns: Tailor the board to fit your project's specific needs with customizable columns.
• Lit: It is powered by Lit, a simple and fast library for building lightweight web components.

Getting Started

To get started with the Kanban Board, clone this repository and follow the setup instructions below.

Prerequisites

• Node.js
• npm

Installation

1. Clone the repository:

   git clone https://github.com/phfsantos/kanban-board.git

2. Navigate to the project directory:

   cd kanban-board

3. Install the dependencies:

   npm install

Usage

To launch the Kanban Board, run the following command:

npm start

This will open the board in your default web browser.

Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag “enhancement”.

Don’t forget to give the project a star! Thanks again!

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Pedro Santos - @ordepim - [email protected] - Project Link: https://github.com/phfsantos/kanban-board

Acknowledgments

• Domenic (dcode) - @dcodeyt - Project Link: https://github.com/dcode-youtube/kanban-board

Please make sure to update the placeholders (like `Your Name`, `@your_twitter`, and `[email protected]`) with your actual information. Also, feel free to adjust the sections according to the specifics of the `kanban-board` project. Enjoy managing your projects with the new Kanban Board!