Fork me on GitHub

Quick Start


Once you've downloaded TaskBoard, getting it running is very simple.

  1. Copy the folders and files (you can skip the .hg* stuff) to the location you want to use TaskBoard.
  2. Optional: Minify everything for better performance in production. (Requires that everything but compiler.jar in build/ is executable.)
    • Open the TaskBoard directory in a terminal
    • Run ./build/build-all
  3. Open your browser to the location you put TaskBoard and log into the site with the username admin and password admin.

Ensure the api directory is writable so the back end can do its job.

That's all there is to it! If you have any troubles, post an issue and I'll help if I can.

First Use

Log In

When you log into TaskBoard, you are taken to the Boards page. Since this is your first login, TaskBoard reminds you to go to Settings and create your first board. It also reminds you to change your password from the default. This should be the first thing you do.

Go to Settings from either the link in the white content area, or the navigation button at the top right.

On future logins, this will either give you a list of available boards or take you to your default board.



After navigating to the Settings page, use the Change Password form to update your password. TaskBoard only has one restriction on passwords; they may not be empty.

From this same User Settings section, you may also change your username and add additional users. We'll get to that in a minute.

You can't select a default board however, because we haven't create one.

Create a Board

Click the Add Board button to open the modal dialog for creating a new board.

There are only two requirements to create a new board. It must have a Name, and it must have at least one Column. Categories are optional, but they can be helpful!

The Select Users section isn't useful at this point, but when there are multiple users, you may select which have access to the board here.Admin users always have access to all boards whether they are selected here or not.

Click the Add Board button on the dialog when you have your first board the way you want. You are returned to the Settings page assuming the two requirements for creating a board were met.

Notice the Settings page now has your board listed in the Board Settings section. Clicking the link in the Name column takes you to the board.

Since you are logged in as an admin user, you also have two icons in the Actions column. The first () allows you to edit the board (using a modal much like the Add Board dialog). The second () allows you to delete a board. Be careful when deleting a board as it cannot be undone!

Add a User

Click the Add User button to open a modal dialog for creating a new user.

Enter the username you want to use, keeping in mind that duplicate usernames are not allowed, then set a password and verify it in the next two fields.

At this point you may also select a default board for the user. Doing this automatically adds the user to that board.If you do not assign a default board, you will need to edit whatever boards you want the user to have access to and add them.

The last option is whether or not the new user is an administrator. By default, this is not checked.

Now that we've covered the main features of the Settings page, let's take a look at that board.

You can either click the direct link in the Board Settings section, or use the navigation button in the top right to be taken to your default board (or a list of boards if you did not choose a default).

Boards & Items

Board Overview

There are a few things to note on the board page. There is a board navigation section which includes a board selector on the left, and filters for the current board on the right.

The filters allow for finer grain detail on board items. For example, if a user wants to see only those items assigned to them, they can select their username from the User Filter dropdown.If you did not add any categories when you created the board, the Category Filter dropdown will not be visible.

Each column in the board is displayed in the main area of the page. Columns may be expanded and collapsed and the setting will persist for each user across logins. When a column is collapsed it has a badge showing the number of items contained within.

Adding an Item

There are two ways to add an item to a column. Either click the plus button or right-click in the column where you want to add an item and select Add Item from the context menu. However you choose, you will get an Add Item modal dialog that has the Column dropdown defaulted to the one you acted from.

When adding an item, the only requirement is that it have a Title.

The Description text can be entered as Markdown for better readability. This allows for lists, formatting, code display, tables, and much more.

The Assigned To dropdown lets you choose a user to have the item assigned to them. The Category dropdown will only be visible if categories were added to the board, and allows for clearer visibility of item types.

You can change the column the item will be created in (in case you clicked whichever column was nearest) from the Column dropdown.

The Color input displays a colorpicker that stores the colors you've used in your browser for future use. It also allows manual entry of colors.

The Date Due input displays a standard datepicker, which should be familiar to most users.

And finally, the Points input is meant to be used to provide an estimate for the level of work required for the item.

More Detail

Now you know enough to get going with TaskBoard. If you'd like more information, including working with Items, take a look through the detailed docs.