Tikship

Prerequisites

Before you begin, make sure you have:

Node.js >= 20.9.0
npm, pnpm, or yarn
Database: PostgreSQL, MySQL, or SQLite
Git for version control

We recommend PostgreSQL for production and SQLite for quick local development.

Steps

Clone the Repository

git clone https://github.com/yorsal-org/tikship
cd tikship

Install Dependencies

npm ci

Or with your preferred package manager:

pnpm install
# or
yarn install

Initialize the Project

Run the initialization script to set up your database and environment:

npm run init

This will:

Create .env file from template
Set up database schema
Run migrations
Seed initial data (all system permissions, default Admin role, superuser account)

Start Development Server

npm run dev

Your app is now running at:

Frontend: http://localhost:3000
Admin Panel: http://localhost:3000/admin (configurable via admin.path in src/config/site.ts)
API Docs: http://localhost:3000/api-docs
Documentation: http://localhost:3000/docs

Default Credentials

After initialization, the superuser account is created with:

Field	Default	Override via env
Username	`tikship`	`ADMIN_USERNAME`
Email	`tikship@example.com`	`ADMIN_EMAIL`
Password	Random 8-char string	—

The password is randomly generated on first run and printed to the console. Save it immediately — it cannot be recovered. Use npm run db:reset-admin-password to reset if lost.

Installation