apollo/pelican
1
0
Fork 0
Code Issues 2 Pull requests Projects 1 Releases Activity Actions
A simple Kanban board for the terminal.
8 commits 2 branches 2 tags 2.8 MiB
Go 100%
Find a file
Dan Anglin 2e80c04917
tests: remove TestOpenDataBaseXDGDataDir
2023-12-12 13:08:41 +00:00
.forgejo/workflows chore: project maintenance 2023-12-12 10:05:25 +00:00
cmd/pelican feat(BREAKING): specify project path 2023-12-12 12:47:58 +00:00
internal tests: remove TestOpenDataBaseXDGDataDir 2023-12-12 13:08:41 +00:00
magefiles feat(BREAKING): specify project path 2023-12-12 12:47:58 +00:00
test/databases feat: add the pelican project 2023-05-06 12:49:40 +01:00
.gitignore chore(db): remove unused function 2023-12-12 13:04:50 +00:00
.golangci.yaml ci(lint): allow failing lint test for now 2023-12-12 10:18:05 +00:00
go.mod chore: project maintenance 2023-12-12 10:05:25 +00:00
go.sum chore: project maintenance 2023-12-12 10:05:25 +00:00
LICENSE feat: add the pelican project 2023-05-06 12:49:40 +01:00
README.asciidoc feat(BREAKING): specify project path 2023-12-12 12:47:58 +00:00

README.asciidoc

Pelican

Contents

Overview

This project is WIP and is not meant for production use.

Pelican is a simple Kanban board for your terminal. Data is stored in a BoltDB database. Pelican does not make any assumptions to the path of the database file; instead the user is expected to specify the path when running the application.

Installation

Requirements

Go

A minimum version of Go 1.21.0 is required for installing spruce. Please go here to download the latest version.

Mage (Optional)

The project includes a magefile for automating the build and installation of the binary. You can visit the website for instructions on how to install Mage.

Install with Mage

TBC

Install with Go

If your GOBIN directory is included in your PATH then you can install Pelican with Go.

git clone https://codeflow.dananglin.me.uk/apollo/pelican.git
cd pelican
go install ./cmd/pelican

Running Pelican

To create a new Kanban project with Pelican, simply run the following command:

pelican ./project.pelican

This will create a new BoltDB database file called project.pelican in your current directory and initialises the database with an empty project.

Keybindings

Key Action

CTRL + q

Quit the application

a

Add card

CTRL + d

Delete card

m

Move card between statuses

Inspiration