Get your VibeFast app running in just a few minutes with this step-by-step guide.

This guide will get you from cloning the repository to running the VibeFast app on your machine.

Step 1: Prerequisites

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

Node.js: We recommend using the latest LTS version.
pnpm: VibeFast uses pnpm as its package manager. If you don't have it, install it globally:
```
npm install -g pnpm
```
Expo & EAS CLI: The project uses the Expo and EAS command-line tools. Install them globally:
```
pnpm install -g expo-cli eas-cli
```

PNPM is Required

The repository includes a pre-commit hook that enforces the use of pnpm. Using npm or yarn will result in an error.

Step 2: Clone & Install

Clone the VibeFast Pro repository and install all dependencies.

git clone https://github.com/mzafarr/vibefast-pro.git
cd vibefast-pro
pnpm install

Step 3: Configure Environment Variables

VibeFast requires environment variables to connect to services like Convex and other third-party APIs.

Create a new file named .env.local in the root of the project.

Populate it with the necessary keys. You will need to get these from their respective services.

.env.local

# Convex Backend URL (get this after running `npx convex dev`)
CONVEX_URL=

# Other variables from your env.js file...
SENTRY_DSN=
REVENUECAT_API_KEY_APPLE=
AUTH_GOOGLE_ID=
# ...and so on.

Step 4: Initialize the Convex Backend

Now, let's get your backend running.

Start the Convex Dev Server: Run the following command. This will link your project to Convex and start the development server.
```
npx convex dev
```
Follow the on-screen prompts to log in and create a new project. Once complete, Convex will provide you with a Deployment URL.
Update Your Environment File: Copy the CONVEX_URL from the terminal and paste it into your .env.local file.
Push Environment Variables to Convex: Sync your local environment variables with the Convex dashboard. This is crucial for your backend functions.
```
node scripts/convex-setup.js .env.local
```