Getting Started

This guide will help you set up the Beztack project on your local machine.

Prerequisites

Make sure you have installed:

• Node.js (LTS version recommended)
• pnpm (package manager)
• Git

Create a New Project

You can create a new Beztack project using the create-beztack command:

pnpm create beztack

The script will walk you through a few setup steps:

• Project name: The name for your new project (lowercase with dashes)
• Project description: A short description of your project
• Initialize Git repo?: Choose if you want to set up a new Git repository
• Install dependencies?: Choose if you want to automatically install dependencies using pnpm install

Initial Setup

Once the project is created, navigate to the directory and set up your environment:

1. Set Up Environment Variables

Copy the .env.example file to .env:

cd your-project
cp  apps/api/.env.example apps/api/.env
cp  apps/ui/.env.example apps/ui/.env
cp  apps/docs/.env.example apps/docs/.env

2. Configure Required Variables

Open the .env files in each app directory and set the variables.

3. Initialize the Database

Run database migrations:

pnpm run push

Development

To start the dev server (UI + API):

pnpm run dev

This will start:

• UI at http://localhost:5173
• API at http://localhost:3000

Additional Nx Commands

Beztack uses Nx for task execution. You can run individual apps:

• UI: npx nx serve ui
• API: npx nx serve api
• Docs: npx nx serve docs (Defaults to http://localhost:3001)

Production Build

To build all projects:

pnpm run build

Or build specific projects:

npx nx build ui
npx nx build api