Installation

Get your build-elevate project up and running in minutes.

Prerequisites

Before you begin, make sure you have the following installed on your system:

Verify Your Installation

Check that Node.js is installed correctly:

node --version
# Should output: v20.x.x or higher

Create Your Project

Option 1: Interactive Setup (Recommended)

Run the following command and follow the prompts:

npx build-elevate@latest init

You'll be asked:

1. Project name - Enter your project name (e.g., my-saas-app)
2. Package manager - Choose between pnpm, npm, or bun
3. Docker - Opt to include Docker configuration
4. Prisma Studio - Choose to include Prisma Studio for database management

Option 2: Direct Installation

You can also specify options directly:

pnpm dlx build-elevate@latest init my-project -y

What Gets Created?

After running the command, you'll have this structure:

my-project/
├── apps/
│   ├── web/              # Next.js frontend
│   ├── api/              # Express backend
│   ├── email/            # Email templates
│   └── studio/           # Database UI
├── packages/
│   ├── auth/             # Authentication logic
│   ├── db/               # Prisma & database
│   ├── ui/               # React components
│   ├── email/            # Email templates
│   ├── utils/            # Shared utilities
│   └── rate-limit/       # API rate limiting
├── package.json
├── turbo.json
└── pnpm-workspace.yaml

Post-Installation Steps

1. Navigate to Your Project

cd my-project

2. Open in Your Editor

code .  # VS Code
# or
cursor .  # Cursor

3. Review the Files

Take a moment to explore:

• README.md - Project overview and commands
• turbo.json - Turborepo pipeline configuration
• package.json - Available scripts and dependencies

Environment Configuration

Before running the project, you need to configure environment variables. We'll cover this in detail in the next section.

Alternative Installation Methods

Clone the Repository

If you want to contribute or explore the source code:

# Clone the repository
git clone https://github.com/vijaysingh2219/build-elevate.git

# Navigate to the directory
cd build-elevate

# Install dependencies
pnpm install

# Copy environment files
cp apps/web/.env.example apps/web/.env.local
cp apps/api/.env.example apps/api/.env.local
cp packages/db/.env.example packages/db/.env

Use as Template

You can also use it as a GitHub template:

1. Visit github.com/vijaysingh2219/build-elevate
2. Click "Use this template"
3. Create your repository
4. Clone and install dependencies