Skip to content

Installation

Get BlockForge up and running on your local machine or deploy it to production.

Prerequisites

Before installing BlockForge, make sure you have:

  • Node.js 18+ and npm
  • Supabase account and project (for backend services)

Installation Steps

1. Clone the Repository

bash
git clone https://github.com/simplyoddapps/blockforge.git
cd blockforge

2. Install Dependencies

bash
npm install

3. Set Up Environment Variables

Create a .env.local file in the root directory:

bash
VITE_SUPABASE_URL=your_supabase_project_url
VITE_SUPABASE_ANON_KEY=your_supabase_anon_key

# Optional: AI Configuration
VITE_AI_API_KEY=your_ai_api_key
VITE_AI_PROVIDER=openai  # or 'anthropic'
VITE_AI_MODEL=gpt-4o-mini  # or 'claude-3-haiku-20240307'

# Optional: GitHub OAuth (for web integration)
VITE_GITHUB_CLIENT_ID=your_github_client_id

4. Set Up Supabase

  1. Follow the instructions in SUPABASE_SETUP.md
  2. Run SQL scripts in the supabase/ directory
  3. Configure your Supabase project settings

📖 Learn more: See Supabase Setup Guide for detailed instructions.

5. Start Development Server

bash
npm run dev

Open http://localhost:5173 in your browser.

Available Scripts

  • npm run dev - Start development server
  • npm run build - Build for production
  • npm run preview - Preview production build
  • npm run lint - Run ESLint
  • npm run tauri:dev - Start Tauri desktop app (dev)
  • npm run tauri:build - Build Tauri desktop app

Next Steps

Built with ❤️ for BlockForge