β‘Quickstart
Get AskGov running locally in 30 minutes to evaluate its capabilities
π Quickstart Guide
Overview
Prerequisites
Quick Prerequisites Check
# Check Node.js version
node --version
# Check npm version
npm --version
# Check Docker is running
docker --version
docker ps # Should not errorStep 1: Clone and Setup (5 minutes)
1.1 Clone the Repository
1.2 Configure Environment
1.3 Install Dependencies
Step 2: Database Setup (5 minutes)
2.1 Start CockroachDB in Docker
2.2 Initialize Database Schema
2.3 Build the Application
Step 3: Start Development Server (2 minutes)
Step 4: Access and Explore (10 minutes)
4.1 Open AskGov
4.2 Test User Accounts
4.3 Key Features to Explore
Step 5: Enable Hybrid Search (Optional, 5 minutes)
5.1 Start Weaviate (Local Development)
5.2 Initialize Search Index
5.3 Verify Search
Step 6: Customization Preview (5 minutes)
6.1 Basic Branding
6.2 Add Your Agency
Troubleshooting
Common Issues and Solutions
Next Steps
For Evaluation
For Development
For Deployment
Quick Command Reference
Last updated
Was this helpful?