🏗️ Blue Collar Connect

Empowering Rural Blue-Collar Workers Through Technology

Bridging the gap between skilled workers and meaningful employment opportunities

---

🎯 Mission Statement

Blue Collar Connect is more than just a job platform—it's a comprehensive ecosystem designed to empower rural blue-collar workers by providing them with the tools, connections, and resources they need to thrive in today's economy. We believe that every skilled worker deserves access to quality job opportunities, regardless of their location or background.

🌟 What Makes Us Different

• Rural-First Approach: Specifically designed for underserved rural communities
• Community-Centric: Building supportive networks, not just job boards
• AI-Powered Guidance: Smart assistance for navigating labor rights and opportunities
• Location Intelligence: Leveraging maps and proximity to connect local talent
• Skills-Based Matching: Highlighting expertise over credentials

---

✨ Core Features

🔍 Intelligent Job Discovery

• Smart Listings – Advanced filtering and search capabilities for blue-collar roles
• Skills Matching – AI-powered job recommendations based on worker profiles
• Real-Time Updates – Instant notifications for new opportunities in your area
• Application Tracking – Monitor your job applications and response status

🗺️ Location-Based Services

• Interactive Maps – Visualize job locations with detailed information
• Proximity Search – Find opportunities within your preferred commute range
• Route Planning – Get directions and travel time estimates
• Local Market Insights – Understand job availability in different regions

👥 Thriving Community

• Worker Network – Connect with peers in your industry
• Employer Engagement – Direct communication with hiring managers
• Experience Sharing – Learn from success stories and challenges
• Mentorship Programs – Connect with experienced professionals

👤 Professional Profiles

• Skills Showcase – Highlight technical abilities and certifications
• Portfolio Management – Display work samples and project photos
• Verification System – Build credibility with verified credentials
• Growth Tracking – Monitor skill development and career progression

🤖 AI-Powered Assistant

• RAG Chatbot Technology – Advanced conversational AI for instant support
• Labor Law Guidance – Real-time answers about worker rights and regulations
• Wage Intelligence – Current salary data and negotiation insights
• Government Schemes – Information about available support programs and benefits

🔐 Security & Privacy

• Enterprise Authentication – Firebase-powered secure access
• Data Protection – GDPR-compliant privacy controls
• Profile Management – Granular control over information visibility
• Secure Communications – Encrypted messaging between users

---

🛠️ Technology Stack

Frontend Layer

Technology	Purpose	Version
Next.js	React framework with SSR	14.x
React	UI component library	18.x
Tailwind CSS	Utility-first styling	3.x
shadcn/ui	Modern component system	Latest
Google Maps API	Location services	v3
Firebase Auth	Authentication	9.x

Backend Layer

Technology	Purpose	Version
Hono.js	Fast web framework	Latest
Firebase	Database & auth	9.x
Node.js	Runtime environment	18.x

AI & Intelligence

Technology	Purpose	Version
FastAPI	Python web framework	Latest
Langchain	LLM orchestration	Latest
Vertex AI	Google Cloud AI	Latest
Gemini	Google's LLM	Latest

Development & Deployment

Tool	Purpose
Google Project IDX	Cloud development environment
Vercel	Frontend deployment
Google Cloud	AI services & credentials
Git	Version control

---

🚀 Quick Start Guide

Prerequisites Checklist

Before you begin, ensure you have:

• ✅ Node.js (v18.0.0 or higher) & npm
• ✅ Python (v3.8+) & pip
• ✅ Google Cloud SDK installed and configured
• ✅ Git for version control
• ✅ Google Cloud Project with required APIs enabled

1. Repository Setup

# Clone the main repository
git clone https://github.com/AyMk544/blue-collar-connect.git
cd blue-collar-connect

# Verify repository structure
ls -la
# Should show: frontend/, server/, ai/, README.md, etc.

2. Frontend Setup

# Navigate to frontend directory
cd frontend

# Install dependencies
npm install

# Create environment file
cp .env.example .env.local
# Edit .env.local with your configuration

3. Backend Setup

# Navigate to server directory  
cd ../server

# Install dependencies
npm install

# Create environment file
cp .env.example .env
# Edit .env with your configuration

4. AI Module Setup

# Navigate to AI directory
cd ../ai

# Create virtual environment (recommended)
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install dependencies
pip install -r requirements.txt

# Create environment file
cp .env.example .env
# Edit .env with your AI service configuration

---

🔧 Environment Configuration

Frontend Environment (.env.local)

# Firebase Configuration
NEXT_PUBLIC_FIREBASE_API_KEY=your_firebase_api_key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your_project.firebaseapp.com
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your_project_id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your_project.appspot.com
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your_sender_id
NEXT_PUBLIC_FIREBASE_APP_ID=your_app_id
NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=your_measurement_id

# API Endpoints
NEXT_PUBLIC_BACKEND_URL=http://localhost:3001
NEXT_PUBLIC_CHAT_URL=http://localhost:8000

# External Services
NEXT_PUBLIC_GOOGLE_MAPS_API_KEY=your_google_maps_api_key

Backend Environment (.env)

# Server Configuration
PORT=3001

# Firebase Configuration
FIREBASE_API_KEY=your_firebase_api_key
FIREBASE_APP_AUTH_DOMAIN=your_project.firebaseapp.com
FIREBASE_PROJECT_ID=your_project_id
FIREBASE_STORAGE_BUCKET=your_project.appspot.com
FIREBASE_MESSAGING_SENDER_ID=your_sender_id
FIREBASE_APP_ID=your_app_id
FIREBASE_MEASUREMENT_ID=your_measurement_id
FIREBASE_SERVICE_ACCOUNT=path/to/service-account-key.json

# Development/Testing
TEST_USER_EMAIL=[email protected]
TEST_USER_PASSWORD=test_password_123

AI Module Environment (.env)

# Google Cloud AI Configuration
GOOGLE_CLOUD_PROJECT=your_gcp_project_id
GOOGLE_API_KEY=your_google_api_key
GOOGLE_MODEL_ID=gemini-pro
EMBEDDINGS_MODEL_ID=textembedding-gecko@001

# Additional AI Configuration
VECTOR_DB_PATH=./vector_store
RAG_MODEL_TEMPERATURE=0.1
MAX_TOKENS=2048

---

🎬 Running the Platform

Development Mode

Start each service in separate terminal windows:

Terminal 1: Frontend

cd frontend
npm run dev
# 🚀 Frontend running at http://localhost:3000

Terminal 2: Backend

cd server
npm run dev
# 🔧 Backend API running at http://localhost:3001

Terminal 3: AI Module

cd ai
source venv/bin/activate  # Activate virtual environment
uvicorn main:api --reload --port 8000
# 🤖 AI Service running at http://localhost:8000

Production Deployment

Each component can be deployed independently:

• Frontend: Deployed on Vercel (automatic from GitHub)
• Backend: Can be deployed on Railway, Vercel, or Google Cloud Run
• AI Module: Best deployed on Google Cloud Run or similar container platform

---

📊 Project Structure

blue-collar-connect/
├── 📁 frontend/                 # Next.js React application
│   ├── 📁 app/                  # Next.js 13+ app directory
│   ├── 📁 components/           # Reusable UI components
│   ├── 📁 lib/                  # Utility functions
│   ├── 📁 public/               # Static assets
│   └── 📄 package.json          # Frontend dependencies
├── 📁 server/                   # Hono.js backend API
│   ├── 📁 src/                  # Source code
│   ├── 📁 routes/               # API route handlers
│   ├── 📁 middleware/           # Custom middleware
│   └── 📄 package.json          # Backend dependencies
├── 📁 ai/                       # FastAPI AI module
│   ├── 📄 main.py               # FastAPI application
│   ├── 📁 models/               # AI model configurations
│   ├── 📁 utils/                # Utility functions
│   └── 📄 requirements.txt      # Python dependencies
├── 📁 docs/                     # Documentation
└── 📄 README.md                 # This file

---

🤝 Contributing to Blue Collar Connect

We welcome contributors who share our mission of empowering blue-collar workers! Here's how you can get involved:

Development Workflow

1. 🍴 Fork the repository on GitHub
2. 📥 Clone your fork locally:

   git clone https://github.com/YOUR_USERNAME/blue-collar-connect.git

3. 🌿 Create a feature branch:

   git checkout -b feature/amazing-new-feature

4. 💻 Make your changes following our coding standards
5. ✅ Test your changes thoroughly
6. 📝 Commit with clear messages:

   git commit -m "feat: add amazing new feature for worker profiles"

7. 🚀 Push to your fork:

   git push origin feature/amazing-new-feature

8. 🔄 Open a Pull Request with detailed description

Contribution Areas

• 🎨 Frontend Development – UI/UX improvements and new features
• 🔧 Backend Development – API enhancements and database optimizations
• 🤖 AI/ML Development – Chatbot improvements and new AI features
• 📱 Mobile Experience – PWA enhancements and mobile optimizations
• 🧪 Testing – Unit tests, integration tests, and quality assurance
• 📚 Documentation – Improving guides, tutorials, and API docs
• 🌍 Localization – Adding support for regional languages
• ♿ Accessibility – Making the platform more inclusive

Code Standards

• Follow existing code style and conventions
• Write meaningful commit messages using conventional commits
• Add tests for new features
• Update documentation for any API changes
• Ensure code passes all linting and formatting checks

---

📈 Performance & Scalability

• Lighthouse Score: 95+ on all metrics
• Core Web Vitals: Optimized for excellent user experience
• Progressive Web App: Works offline and can be installed
• Edge Deployment: Global CDN for fast loading times
• Database Optimization: Efficient queries and caching strategies
• AI Response Time: < 2 seconds for most chatbot queries

---

🔒 Security & Privacy

Security Measures

• Authentication: Multi-factor authentication with Firebase
• Data Encryption: TLS 1.3 for data in transit, AES-256 for data at rest
• API Security: Rate limiting, CORS policies, and input validation
• Regular Audits: Automated security scanning and vulnerability assessment

Privacy Protection

• GDPR Compliance: Full compliance with data protection regulations
• Data Minimization: Collect only necessary information
• User Control: Granular privacy settings and data export options
• Transparent Policies: Clear privacy policy and terms of service

---

📄 License & Legal

This project is licensed under the MIT License - see the LICENSE file for full details.

Third-Party Licenses

• Google Maps API: Subject to Google Cloud Terms of Service
• Firebase: Subject to Google Cloud Terms of Service
• All npm packages: See individual package licenses in package.json files

---

🆘 Support & Community

Get Help & Stay Connected

Support Channels

• 📧 Email: [email protected]
• 🐛 Bug Reports: GitHub Issues
• 💡 Feature Requests: GitHub Discussions
• 📚 Documentation: Wiki

Response Times

• Critical Issues: Within 24 hours
• Bug Reports: Within 48 hours
• Feature Requests: Within 1 week
• General Inquiries: Within 72 hours

---

🙏 Acknowledgments

Special thanks to:

• Rural communities who inspired this platform
• Blue-collar workers who provided valuable feedback
• Open source contributors who made this project possible
• Google Cloud for AI and infrastructure services
• Vercel for seamless deployment and hosting

---

🌟 Star this repository if you believe in empowering blue-collar workers! 🌟

Made with ❤️ for the hardworking people who build our world