Teese

Minimal Kanban board Web application. Uses Varasto as storage, while the UI has been implemented with React and Material UI.

Requirements

• Node.js 22 or newer
• npm or Yarn (a yarn.lock is included)

Installation

From source

Clone this repository, then install dependencies:

git clone https://github.com/RauliL/teese.git
cd teese
npm install

For a production build of the UI and server bundle:

npm run build

From npm

Install the package and production dependencies only:

npm install teese

The published package includes the prebuilt dist/ output; you do not need TypeScript sources or a local build step to run the server.

First use

Teese stores users and boards as JSON files under ./data by default (set TEESE_AUTH_DATA to keep authentication data elsewhere). On a fresh install there are no accounts yet, so run the interactive setup script:

npm run onboard

With Yarn, use yarn onboard.

You will be prompted for:

• Admin username (default: admin)
• Admin password (at least 8 characters)
• Initial board name (default: My board)

The script creates the administrator account and your first board. It can only be run while no users exist yet.

Recommended for any real deployment:

| Variable | Default | Purpose | | ----------------- | ----------------------- | ---------------------------------------------------------------- | | JWT_SECRET | development placeholder | Secret used to sign authentication tokens | | JWT_EXPIRES_IN | 30d | Token lifetime (passed to jose) | | TEESE_DATA | ./data | Directory for Varasto JSON storage (boards and items) | | TEESE_AUTH_DATA | (unset) | Optional separate directory for authentication data (users) | | PORT | 3000 | HTTP listen port |

By default, users and boards share TEESE_DATA. Set TEESE_AUTH_DATA to store authentication data in a different directory (for example a smaller volume or a more tightly restricted path).

Usage

Development

npm run onboard
npm run start:dev

Open http://localhost:3000, sign in with the admin credentials, then:

1. Open Admin and create any additional users under Users.
2. Create a board under Manage boards and add users to its allowed list.
3. Open the kanban view from the home page to work on items, comments, and status changes.

Production

From a source checkout, onboard and build first:

npm run onboard
npm run build
npm start

When installed from npm, npm start runs the prebuilt server directly.

The server listens on port 3000 unless you override it with PORT.

Attributions

Icon by Pexelpy on freeicons.io