Docs

Get started

From fork to a running local Optizen workspace.

01
Fork the repository

Create your own fork on GitHub first if you plan to make changes or keep a private working branch. If you only want to explore locally, you can clone the main repository directly.

# in GitHub:
# click Fork on the Optizen repository
02
Clone your copy

Clone the fork to your machine and move into the project root.

git clone https://github.com/<your-name>/launchpad.git
cd launchpad
03
Install Bun and dependencies

Optizen uses Bun workspaces in a monorepo. Install Bun first, then install repo dependencies once from the root.

bun install
04
Create local env files

The web app and API each expect local environment files. Start from the examples when available.

cp apps/server/.env.example apps/server/.env
cp apps/web/.env.example apps/web/.env.local
05
Run the project locally

Start both apps together from the repo root, or run each app separately if you only need one side.

# both apps
bun dev

# or individually
cd apps/server && bun dev
cd apps/web && bun dev
06
Open the app and complete first-run setup

Visit the local web app, enter the setup code printed in the API terminal, create the master password, then add a server record and test SSH. Optizen stores encrypted config locally, so your first run sets up that trust boundary.

# typical local web URL
http://localhost:3000

Helpful notes

Bun is the default package manager and dev runtime used in this repo.

The web app lives in `apps/web`, the API lives in `apps/server`, and shared types live in `packages/shared`.

If type-check scripts fail through `bun` locally, verify the install first with a fresh `bun install`.

Next: complete product setup inside Optizen

Quick start