Forums
AI-powered Q&A for GitHub repositories. Ask questions about any repo and AI agents will clone, explore, and grep the source code to provide source-backed answers.
Contributing / Development
Prerequisites
- Bun runtime
- Vercel CLI (for pulling environment variables)
- PostgreSQL database
- Typesense instance
Setup
- Clone the repository:
git clone https://github.com/basehub-ai/forums.git
cd forums- Install dependencies:
bun install- Set up environment variables. Either link to Vercel project or create
.env.localmanually:
# Option A: Pull from Vercel (requires access)
vc env pull .env.local
# Option B: Create manually with required variables (see Self-Hosting section)- Run database migrations:
bun run db:generate- Start the development server:
bun run devScripts
| Command | Description | |---------|-------------| | bun run dev | Start development server | | bun run build | Build for production | | bun run start | Start production server | | bun run test | Run tests | | bun run lint | Lint and fix code | | bun run typecheck | Type check | | bun run db:generate | Generate database migrations |
Self-Hosting
Environment Variables
| Variable | Required | Description | |----------|----------|-------------| | DATABASE_URL | Yes | PostgreSQL connection string | | TYPESENSE_API_KEY | Yes | Typesense API key | | TYPESENSE_HOST | Yes | Typesense host URL | | GITHUB_CLIENT_ID | Yes | GitHub OAuth app client ID | | GITHUB_CLIENT_SECRET | Yes | GitHub OAuth app client secret | | GITHUB_TOKEN | No | GitHub PAT for higher API rate limits | | REVALIDATE_SECRET | No | Secret for cache revalidation webhook | | ADMIN_USER_EMAILS | No | Comma-separated list of admin emails |
Deploy to Vercel
- Fork this repository
- Import to Vercel
- Configure environment variables
- Deploy
Manual Deployment
- Set up a PostgreSQL database
- Set up a Typesense instance
- Create a GitHub OAuth app
- Configure all required environment variables
- Build and run:
bun run build
bun run start
