DocumentationLocal Setup

Local Development

Set up Tijori on your local machine for development and testing.

Software
Requirements for your dev environment
  • Bun runtime (recommended) or Node.js 20+
  • Git installed and configured
  • A modern browser (Chrome, Firefox, Safari)
  • VS Code or your preferred editor
Accounts Needed
Cloud services used by Tijori
  • Convex Cloud account
  • Clerk account (for auth)

Clone and Install Dependencies

Get the source code and install the required packages.

bash
git clone https://github.com/pantharshit007/tijori.git
cd tijori
bun install

Environment Variables

Configure your local environment with Clerk and Convex keys.

Copy the example environment file and fill in your keys from Clerk and Convex dashboards.

bash
cp .env.example .env.local

For Clerk keys, go to your dashboard and copy the keys from the "API Keys" section. Navigate here API Keys

Update the framework from NextJS to TanStack Start, and update them in your .env.local file.

For detail guide, check the official Convex docs

Required Keys

Clerk (Dev Instance)

VITE_CLERK_PUBLISHABLE_KEY
CLERK_SECRET_KEY
CLERK_JWT_ISSUER_DOMAIN

Convex (Generated when dev server starts)

VITE_CONVEX_URL

Start Development Servers

You need to run both the frontend and the Convex backend simultaneously.

Frontend
Vite + TanStack Start
bash
bun run dev

Runs on http://localhost:3000

Backend
Convex Dev Server
bash
bun run cvx:dev

Syncs schema and functions in real-time

You may be asked to log in to your Convex account; it's up to you whether you want to use the local running Convex instance or the development instance via the cloud. For that, you have to login to your convex account and follow the steps to generate the keys.

You're all set!

Once both servers are running and your environment variables are configured, you should be able to sign in and start creating projects locally.