Quick Start¶

Get CitizenAI up and running in minutes with this comprehensive quick start guide.

Before You Begin¶

Ensure you have completed the Installation process before proceeding.

Running CitizenAI¶

CitizenAI offers two versions to suit different needs:

# Navigate to project directory
cd Citizen-AI

# Run demo version
python app_demo.py

# Run full AI version
python app.py

First Access¶

1. Start the Application

   python app_demo.py
   

2. Open Your Browser Navigate to: http://localhost:5000

3. Login Use the default credentials:

4. Username: admin
5. Password: password

Interface Overview¶

Main Dashboard¶

After logging in, you'll see the main dashboard with:

• 📊 Analytics Cards: Key metrics and statistics
• 📈 Charts: Interactive visualizations
• 🔄 Real-time Updates: Live data refresh
• 📱 Responsive Design: Works on all screen sizes

Navigation Menu¶

Key Features Demo¶

1. AI Chat Assistant¶

sequenceDiagram
    participant C as Citizen
    participant AI as ChatBot
    participant S as System

    C->>AI: Ask question
    AI->>S: Process query
    S->>AI: Generate response
    AI->>C: Provide answer

Try these sample questions:

• "What services are available for new residents?"
• "How do I report a street light issue?"
• "What are the office hours for city hall?"

2. Analytics Dashboard¶

The dashboard displays:

3. Concern Reporting¶

Test the concern reporting system:

1. Navigate to Concerns section
2. Click "Report New Concern"
3. Fill out the form with sample data
4. Submit and track the concern status

Configuration Basics¶

Environment Variables¶

Create a .env file for configuration:

# Basic Configuration
FLASK_ENV=development
FLASK_DEBUG=True
SECRET_KEY=your-secret-key-here

# IBM Watson Configuration (for full AI version)
WATSON_API_KEY=your-watson-api-key
WATSON_URL=your-watson-url
WATSON_VERSION=2021-06-14

Default Settings¶

# Server Settings
HOST = '127.0.0.1'
PORT = 5000
DEBUG = True

# Session Settings
SESSION_TYPE = 'filesystem'
PERMANENT_SESSION_LIFETIME = 1800  # 30 minutes

Testing the Features¶

Chat Functionality¶

1. Navigate to Chat: Click on the "Chat" menu item
2. Start Conversation: Type a message in the input field
3. View Response: See AI-generated or demo responses
4. Test Different Queries: Try various question types

Analytics Features¶

1. View Dashboard: Check real-time metrics
2. Interact with Charts: Hover and click on chart elements
3. Filter Data: Use date pickers and filters
4. Export Data: Download charts and reports

Concern Management¶

1. Submit Concern: Use the concern reporting form
2. Track Status: Monitor concern progress
3. View History: Check past submissions
4. Receive Updates: Get notification updates

Performance Tips¶

Common Workflows¶

For Government Staff¶

flowchart LR
    A[Login] --> B[View Dashboard]
    B --> C[Check Analytics]
    C --> D[Review Concerns]
    D --> E[Respond to Citizens]
    E --> F[Update Status]

For Citizens¶

flowchart LR
    A[Visit Platform] --> B[Ask Question]
    B --> C[Get AI Response]
    C --> D{Satisfied?}
    D -->|Yes| E[End Session]
    D -->|No| F[Report Concern]
    F --> G[Track Progress]

Next Steps¶

Now that you have CitizenAI running:

1. Explore Features: Try all available functionality
2. Configure Settings: Set up Configuration for your needs
3. Read User Guide: Dive deeper into Features
4. API Integration: Check out API Reference

Getting Help¶

• Issues: Check Troubleshooting
• Questions: See FAQ
• Community: Join discussions on GitHub