Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/fatelessdev/translogiX/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through setting up TranslogiX locally from a fresh clone to a running application with sample data. By the end you will have the dev server running at http://localhost:3000, four seeded user accounts ready to sign in, and sample shipments you can explore immediately.
1

Clone the repository

git clone https://github.com/fatelessdev/translogiX.git
cd translogiX
2

Install dependencies

TranslogiX uses pnpm as its package manager. Install it globally if you don’t have it, then install project dependencies:
npm install -g pnpm
pnpm install
3

Set up environment variables

Create a .env file in the project root with the following variables:
DATABASE_URL=postgresql://postgres:postgres@localhost:5432/translogix
BETTER_AUTH_SECRET=your-secret-key-min-32-chars
BETTER_AUTH_URL=http://localhost:3000
VariableDescription
DATABASE_URLPostgreSQL connection string. The default value above matches the Docker Compose configuration exactly.
BETTER_AUTH_SECRETA random secret used to sign authentication tokens. Use at least 32 characters.
BETTER_AUTH_URLThe public base URL of your app. Use http://localhost:3000 for local development.
Generate a strong secret with: openssl rand -base64 32
4

Start the database

TranslogiX requires a PostgreSQL database. The included Docker Compose file starts a PostgreSQL 16 container named translogix-postgres on port 5432:
docker compose up -d
The container is configured with a health check. Wait a few seconds for it to become healthy before proceeding.
The default credentials (postgres / postgres) and database name (translogix) match the DATABASE_URL value in the previous step. If you change them in Docker Compose, update DATABASE_URL to match.
5

Push the database schema

Apply the Drizzle schema to the running database:
pnpm db:push
This introspects lib/db/schema.ts and creates all tables in the translogix database without generating migration files.
6

Seed sample data

Populate the database with realistic sample data:
pnpm db:seed
The seed script creates the following:
ResourceCountDetails
Users4Admin, Transporter, Driver, Customer
Transporters2Swift Cargo, FastRoute Logistics
Vehicles5Trucks, a van, and a dumper across both transporters
Routes3Mumbai→Delhi, Chennai→Bangalore, Kolkata→Hyderabad
Shipments5One in each status: CREATED, ASSIGNED, IN_TRANSIT, PICKED_UP, DELIVERED
Tracking updates8Four each for PKG-003 and PKG-004
All four user accounts share the password password123.
7

Start the development server

pnpm dev
This starts Next.js with Turbopack. Open http://localhost:3000 in your browser.
8

Sign in and explore

Navigate to http://localhost:3000 and sign in with any of the seeded accounts:
RoleEmailPassword
Adminadmin@translogix.compassword123
Transportertransporter@translogix.compassword123
Driverdriver@translogix.compassword123
Customercustomer@translogix.compassword123
Sign in as Admin first to get full visibility across shipments, transporters, vehicles, routes, and the AI Operations panel. Each role sees a tailored dashboard with the actions available to that role.
To browse and edit database records directly, run pnpm db:studio to open the Drizzle Studio UI in your browser.

Build docs developers (and LLMs) love

Get started for freeTalk to us