An open source project management tool with Kanban boards
Go to file
Jordan Knott 0eb9c0db94 feat: implement task group actions
- allow sorting specifc task groups
- duplicate task group
- delete all tasks in task group
2020-09-10 22:33:03 -05:00
.github docs: add pull request template 2020-09-10 16:01:25 -05:00
cmd feat: add pre-commit hooks & refactor code to pass linting 2020-08-20 18:37:36 -05:00
conf feat: replace config system with viper based system 2020-08-12 22:30:53 -05:00
frontend feat: implement task group actions 2020-09-10 22:33:03 -05:00
internal feat: implement task group actions 2020-09-10 22:33:03 -05:00
migrations feat: add notification UI 2020-09-10 15:31:04 -05:00
scripts chore: switch eslint to lint changed files intead of whole project 2020-09-10 22:13:16 -05:00
templates/mail/user arch: move web folder into api & move api to top level 2020-07-04 18:08:37 -05:00
uploads change: add .keep to .gitignore exclusion list 2020-07-04 18:14:05 -05:00
.cz.toml feat: add pre-commit hooks & refactor code to pass linting 2020-08-20 18:37:36 -05:00
.dockerignore chore: update docker & git ignore files 2020-08-12 22:30:53 -05:00
.gitignore chore: update docker & git ignore files 2020-08-12 22:30:53 -05:00
.pre-commit-config.yaml chore: switch eslint to lint changed files intead of whole project 2020-09-10 22:13:16 -05:00
.tmuxinator.yml refactor: update project name in tmuxinator 2020-08-23 17:29:06 -05:00
CHANGELOG.md docs(CHANGELOG): add changelog document 2020-09-02 20:40:56 -05:00
CODE_OF_CONDUCT.md docs: add CODE_OF_CONDUCT.md 2020-08-12 15:27:07 -05:00
CONTRIBUTING.md docs(CONTRIBUTING): add note about asking in discord 2020-09-10 15:57:53 -05:00
docker-compose.dev.yml chore: rename Citadel to Taskcafe 2020-08-06 20:50:35 -05:00
docker-compose.migrate.yml chore: rename Citadel to Taskcafe 2020-08-06 20:50:35 -05:00
docker-compose.yml fix: use pre-built taskcafe image in docker-compose by default 2020-08-23 11:44:50 -05:00
Dockerfile fix(Dockerfile): remove config file from being added 2020-08-14 12:35:56 -05:00
go.mod feat: add notification UI 2020-09-10 15:31:04 -05:00
go.sum feat: add notification UI 2020-09-10 15:31:04 -05:00
gqlgen.yml chore: rename Citadel to Taskcafe 2020-08-06 20:50:35 -05:00
LICENSE change: add LICENSE & basic compile instructions 2020-07-16 23:00:03 -05:00
magefile.go feat: add pre commit hook to lint frontend & fix warnings 2020-08-23 17:29:06 -05:00
Pipfile feat: add pre-commit hooks & refactor code to pass linting 2020-08-20 18:37:36 -05:00
Pipfile.lock feat: add pre-commit hooks & refactor code to pass linting 2020-08-20 18:37:36 -05:00
README.md docs(README): update source build instructions 2020-09-10 15:53:47 -05:00
sqlc.yaml feat: add pre-commit hooks & refactor code to pass linting 2020-08-20 18:37:36 -05:00

Taskcafe logo

Discord Releases Dockerhub Go Report Card

Was this project useful? Please consider donating to help me improve it!

Please note that this project is still in active development. Some options may not work yet! For updates on development, join the Discord server

Features

Currently Taskcafe only offers basic task tracking through a Kanban board.

Currently you can do the following to tasks:

  • Task sorting & filtering
  • Add colors & named labels
  • Add due dates
  • Descriptions written in Markdown
  • Assign members
  • Checklists
  • Mark tasks as complete

For a list of planned features, check out the Roadmap!

Installation

With docker & docker-compose

You'll need both docker & docker-compose installed.

First clone the repository:

git clone https://github.com/JordanKnott/taskcafe && cd taskcafe

Now do the following:

docker-compose -p taskcafe up -d

This will start a postgres instance as well as a taskcafe instance.

The second command runs the database schema migrations.

If you visit http://localhost:3333, you will get redirected to the installation screen so that you can create the first system user.

From Source

You'll need Golang installed on your machine.

Next, clone the repository:

git clone https://github.com/JordanKnott/taskcafe && cd taskcafe

Next we need to build the binary. This project uses Mage for its build tool.

go run cmd/mage/main.go install
go run cmd/mage/main.go build

This will:

  • Install all yarn packages for the frontend
  • Build the React frontend
  • Embed the React frontend in the binary
  • Compile the final exectuable binary

The newly created taskcafe binary can be found in the dist folder.

It contains everything neccessary to run except the config file. An example config file can be found in conf/app.example.toml.

For more information on configuration, please read the wiki. The config will need to be copied to a conf/app.toml in the same place the binary is.

Make sure to fill out the database section of the config in order to connect it to your database.

Then run the database migrations with taskcafe migrate.

Now you can run the web interface by running taskcafe web.

A more detailed guide for installing on Ubuntu/Debian

How is this different from X (Trello, NextCloud, etc)?

One of the primary goals of Taskcafe is to provide a project management tool that I personally enjoy using for my own projects and fits my workflow.

During alpha development, the current plan is to build the "basic" features - features that are pretty much standard across all kanban boards / project management tools.

Once Taskcafe is out of alpha, there are many features that I plan on adding that will differentiate it from other products (check out the Roadmap for ideas on future plans).

Contributing & community

If you have questions regarding how to use Taskcafe, check out the discord server.

If you're interesting in contributing to Taskcafe, please read the contribution guide first!

There is also a Code of Conduct as well.

License

MIT License