Skip to content

Getting Started

This page gets a new contributor or administrator up and running quickly. For the full path from this checkout to a company Jira installation, use Deployment: local, Forge, and company rollout.

Prerequisites

  • Node.js 22 (the supported project and CI runtime)
  • npm
  • A free Atlassian developer account (this is not the same as access to any production/company Jira site)
  • The Forge CLI (installed automatically as a dev dependency via npm ci)

Clone and install

git clone https://github.com/jacksonpradolima/kimai-jira.git
cd kimai-jira
npm ci

Validate the project locally

These commands never require production Forge or Kimai credentials:

npm run lint
npm run typecheck
npm test

Run against your own Forge developer environment

forge lint, forge deploy and forge install need a Atlassian account, but never the production one used by the maintainer's real Jira site. See Development for the full forge register / demo-site provisioning / forge deploy / forge install --demo-site walkthrough.

npx forge login
npx forge register kimai-for-jira
npx forge site provision
npx forge deploy
npx forge install --demo-site

If demo-site provisioning is unavailable, use a separate traditional Jira Cloud development site with npx forge install --site your-dev-site.atlassian.net --product jira; do not substitute a company production site. See Deployment.

Next steps