Skip to main content

​
Quickstart Guide

Get started with Visita Intelligence Platform by setting up your development environment and running the application locally.
1
Step 1: Prerequisites
2
Ensure you have the following installed on your system:
3
  • Node.js (v18 or higher)
  • npm, yarn, or pnpm (package manager)
  • Git (for version control)
  • A Supabase account (for database and authentication)
    • 4
    Need help installing Node.js? Visit the official Node.js website for download instructions.
    5
    Step 2: Clone the Repository
    6
    git clone https://github.com/MisterSeitz/visita-intelligence.git
cd visita-intelligence
    7
    Step 3: Install Dependencies
    8
    npm install
# or
yarn install
# or
pnpm install
    9
    This will install all required dependencies including Next.js, Supabase client, Tailwind CSS, and shadcn/ui components.
    10
    Step 4: Environment Setup
    11
    Create a .env.local file in the root directory and add your Supabase configuration:
    12
    # Supabase Configuration
NEXT_PUBLIC_SUPABASE_URL=https://your-project.supabase.co
NEXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key-here

# Optional: Additional Services
ALGOLIA_APPLICATION_ID=your-algolia-app-id
ALGOLIA_ADMIN_API_KEY=your-algolia-admin-key
REDIS_URL=your-redis-url
SENTRY_DSN=your-sentry-dsn
MAILGUN_API_KEY=your-mailgun-key
PAYSTACK_SECRET_KEY=your-paystack-key
    13
    Never commit your .env.local file to version control. It contains sensitive credentials.
    14
    Step 5: Run the Development Server
    15
    npm run dev
# or
yarn dev
# or
pnpm dev
    16
    Open http://localhost:3000 in your browser to see the application.
    17
    Step 6: Verify Installation
    18
    You should see:
    19
  • The Visita Intelligence homepage
  • Navigation to different sections (Wards, Business, Intelligence)
  • Responsive design working correctly

    • ​
    Project Structure

    visita-intelligence/
├── app/                    # Next.js App Router pages
│   ├── actions/           # Server Actions
│   ├── api/               # API routes
│   ├── platform/          # Authenticated platform
│   ├── ward/              # Ward-specific pages
│   └── ...
├── components/            # React components
│   ├── ui/               # shadcn/ui components
│   ├── ward/             # Ward-specific components
│   ├── business/         # Business components
│   └── ...
├── lib/                   # Utility libraries
│   ├── supabase/         # Supabase client setup
│   ├── ai/               # AI integration
│   └── ...
├── types/                 # TypeScript type definitions
├── supabase/              # Supabase migrations and types
└── docs/                  # Documentation (you are here!)

    ​
    Next Steps

    Read the Philosophy

    Explore Architecture

    Browse Guides

    ​
    Common Issues

    ​
    Issue: “Module not found” errors

    Solution: Clear your node_modules and reinstall: 
    rm -rf node_modules package-lock.json
npm install

    ​
    Issue: Supabase connection errors

    Solution: Verify your environment variables are correct in .env.local: 
    echo $NEXT_PUBLIC_SUPABASE_URL

    ​
    Issue: Port 3000 already in use

    Solution: Use a different port: 
    npm run dev -- -p 3001

    ​
    Getting Help

    • Documentation: Browse our comprehensive guides
    • GitHub Issues: Report bugs or request features
    • Community: Join discussions and contribute
    Ready to dive deeper? Check out our Architecture Overview to understand how Visita is built.