journeyman-jobs

内容来源：README.md（说明文档） · 原始地址 · 查看安装指南

原始内容

# Journeyman Jobs ⚡

**IBEW Mobile Application for Electrical Workers**

A comprehensive Flutter application designed to streamline job referrals and storm work opportunities for IBEW (International Brotherhood of Electrical Workers) journeymen, linemen, wiremen, operators, and tree trimmers.

## 🎯 Overview

Journeyman Jobs connects skilled electrical workers with job opportunities across the United States, with special emphasis on emergency storm restoration work. The app provides real-time job listings, union directory access, and critical weather tracking tools for storm response teams.

## ✨ Key Features

### 📱 Core Functionality

- **Job Board**: Browse and filter electrical work opportunities by classification, location, and type
- **Storm Work Hub**: Priority listings for emergency power restoration with enhanced compensation
- **Union Directory**: Complete directory of 797+ IBEW locals with contact integration
- **Profile Management**: Maintain certifications, work history, and availability status
- **Real-time Notifications**: Instant alerts for new job postings and storm work opportunities

### 🌩️ Weather Integration (NEW)

- **NOAA Weather Radar**: Official US government weather data for storm tracking
- **Live Weather Alerts**: Real-time severe weather warnings from National Weather Service
- **Hurricane Tracking**: National Hurricane Center integration for tropical systems
- **Storm Safety**: Integrated safety protocols and weather-based work recommendations

### 🔌 Electrical-Themed Design

- Custom electrical components and animations
- Circuit pattern backgrounds
- Lightning bolt loading indicators
- Copper and navy color scheme representing electrical heritage

## 🛠️ Technology Stack

- **Frontend**: Flutter 3.x with null safety
- **State Management**: Provider pattern
- **Backend**: Firebase (Authentication, Firestore, Cloud Storage)
- **Navigation**: go_router for type-safe routing
- **Weather Data**: NOAA/NWS APIs (no API key required)
- **Maps**: flutter_map with OpenStreetMap
- **Location**: Geolocator for GPS services

## 📋 Prerequisites

- Flutter SDK 3.6.0 or higher
- Dart SDK (included with Flutter)
- Firebase project configured
- iOS: Xcode 14+ for iOS development
- Android: Android Studio for Android development

## 🚀 Getting Started

1. **Clone the repository**

   ```bash
   git clone https://github.com/yourusername/journeyman-jobs.git
   cd journeyman-jobs
   ```

2. **Install dependencies**

   ```bash
   flutter pub get
   ```

3. **Configure Firebase**
   - Create a Firebase project at <https://console.firebase.google.com>
   - Add iOS and Android apps to your Firebase project
   - Download and add configuration files:
     - iOS: `ios/Runner/GoogleService-Info.plist`
     - Android: `android/app/google-services.json`

4. **Set up environment**

   ```bash
   # Copy the example environment file
   cp .env.example .env
   
   # Add your configuration values
   ```

5. **Run the app**

   ```bash
   # Run on iOS simulator
   flutter run -d ios
   
   # Run on Android emulator
   flutter run -d android
   ```

## 📱 Platform Configuration

### iOS Setup

The following permissions are configured in `ios/Runner/Info.plist`:

- Location Services (for weather radar and job proximity)
- Camera/Photo Library (for profile pictures)
- Push Notifications (for job alerts)

### Android Setup

The following permissions are configured in `android/app/src/main/AndroidManifest.xml`:

- Fine/Coarse Location
- Internet Access
- Notification permissions
- Camera and Storage

## 🏗️ Project Structure

```
lib/
├── main.dart                    # App entry point
├── screens/                     # Screen widgets
│   ├── home/                   # Home dashboard
│   ├── jobs/                   # Job listings and details
│   ├── storm/                  # Storm work hub with weather radar
│   ├── unions/                 # Union directory
│   └── profile/                # User profile management
├── widgets/                     # Reusable UI components
│   ├── job_card.dart          # Job listing card
│   ├── union_card.dart        # Union local card
│   └── weather/               # Weather radar components
├── services/                    # Business logic and API calls
│   ├── auth_service.dart      # Authentication
│   ├── job_service.dart       # Job data management
│   ├── location_service.dart  # GPS and location
│   ├── noaa_weather_service.dart # NOAA weather integration
│   └── notification_service.dart # Push notifications
├── models/                      # Data models
│   ├── job_model.dart         # Job posting structure
│   ├── user_model.dart        # User profile
│   └── storm_event.dart       # Storm work events
├── providers/                   # State management
│   ├── auth_provider.dart     # Authentication state
│   ├── job_provider.dart      # Job listings state
│   └── user_provider.dart     # User data state
├── design_system/              # Theme and styling
│   ├── app_theme.dart         # Colors, typography, spacing
│   └── components/            # Design system components
├── electrical_components/       # Custom electrical UI elements
└── navigation/                 # Router configuration
    └── app_router.dart        # go_router setup
```

## 🌦️ Weather Integration Details

The app integrates with multiple NOAA services for comprehensive weather tracking:

- **National Weather Service API**: Real-time alerts and forecasts
- **NOAA Radar Stations**: Direct radar imagery from 200+ stations
- **National Hurricane Center**: Tropical storm tracking
- **Storm Prediction Center**: Severe weather outlooks

All weather data is free and requires no API keys.

## 🧪 Testing

```bash
# Run unit tests
flutter test

# Run widget tests
flutter test test/widgets/

# Run integration tests
flutter test integration_test/
```

## 📦 Building for Production

### iOS

```bash
flutter build ios --release
```

### Android

```bash
flutter build apk --release
# or for app bundle
flutter build appbundle --release
```

## 🚀 Deployment

### Manual Deployment

To deploy the Flutter web app to Firebase Hosting:

1. **Install Firebase CLI** (if not already installed):
   ```
   npm install -g firebase-tools
   ```

2. **Login to Firebase**:
   ```
   firebase login
   ```

3. **Build the web app**:
   ```
   flutter build web --web-renderer canvaskit --release
   ```

4. **Deploy to Firebase Hosting**:
   ```
   firebase deploy --only hosting
   ```

5. **Full deployment** (includes Cloud Functions, Firestore indexes, and Hosting):
   ```
   firebase deploy
   ```

**Prerequisites**:
- Ensure `firebase.json` is configured with hosting settings.
- For full deploys, have Cloud Functions and Firestore indexes ready.
- User must set up Firebase project and install dependencies.

### CI/CD with GitHub Actions

The project includes automated deployment workflows:

- **Production Deploy**: `.github/workflows/firebase-hosting-merge.yml`
  - Triggers on push to `main` branch.
  - Runs tests, builds web app, deploys to Firebase Hosting (live channel).

- **PR Previews**: `.github/workflows/firebase-hosting-pull-request.yml`
  - Triggers on pull request open/synchronize.
  - Runs tests, builds web app, deploys to preview channel for review.

**Setup Instructions**:
1. In your GitHub repository, go to **Settings > Secrets and variables > Actions**.
2. Add the following repository secret:
   - `FIREBASE_SERVICE_ACCOUNT_JOURNEYMAN_JOBS`: Paste your Firebase service account JSON key (generate from Firebase Console > Project Settings > Service Accounts).
3. Commit and push changes to trigger workflows.
4. For PR previews, Firebase will provide a unique URL in the Actions tab.

**Notes**:
- No `FIREBASE_TOKEN` needed; uses service account for authentication.
- Ensure Flutter cache is enabled for faster builds.
- Monitor workflow runs in GitHub Actions tab.

### Monitoring and Analytics

- **Firebase Performance Monitoring**: Integrated in `main.dart` to track app performance (network requests, screen rendering).
- **Firebase Crashlytics**: Set up for automatic error reporting; records fatal/non-fatal errors in services.
- **Firebase Analytics**: Logs key events (e.g., post created, job shared) via `analytics_service.dart`.
- **Dashboards**: Access via Firebase Console:
  - Performance tab for traces and metrics.
  - Crashlytics for crash reports.
  - Analytics for user events and conversions.

**Additional Setup**:
- Enable Performance Monitoring and Crashlytics in Firebase Console if not already.
- For production, review Firebase quotas and billing.

## 🤝 Contributing

1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request

## 📄 License

This project is proprietary software for IBEW use. All rights reserved.

## 👥 Team

- **Development**: Terragon Labs
- **Design**: Electrical theme inspired by IBEW heritage
- **Weather Data**: NOAA/National Weather Service

## 📞 Support

For support, please contact:

- Technical Issues: <support@journeymanjobs.com>
- IBEW Questions: Contact your local union

## 🔒 Security

- All user data is encrypted in transit and at rest
- Firebase Authentication handles secure login
- Location data is only used for job matching and weather alerts
- No personal information is shared without consent

---

**Built with ⚡ for IBEW electrical workers**

Journeyman Jobs ⚡

IBEW Mobile Application for Electrical Workers

A comprehensive Flutter application designed to streamline job referrals and storm work opportunities for IBEW (International Brotherhood of Electrical Workers) journeymen, linemen, wiremen, operators, and tree trimmers.

🎯 Overview

Journeyman Jobs connects skilled electrical workers with job opportunities across the United States, with special emphasis on emergency storm restoration work. The app provides real-time job listings, union directory access, and critical weather tracking tools for storm response teams.

✨ Key Features

📱 Core Functionality

Job Board: Browse and filter electrical work opportunities by classification, location, and type
Storm Work Hub: Priority listings for emergency power restoration with enhanced compensation
Union Directory: Complete directory of 797+ IBEW locals with contact integration
Profile Management: Maintain certifications, work history, and availability status
Real-time Notifications: Instant alerts for new job postings and storm work opportunities

🌩️ Weather Integration (NEW)

NOAA Weather Radar: Official US government weather data for storm tracking
Live Weather Alerts: Real-time severe weather warnings from National Weather Service
Hurricane Tracking: National Hurricane Center integration for tropical systems
Storm Safety: Integrated safety protocols and weather-based work recommendations

🔌 Electrical-Themed Design

Custom electrical components and animations
Circuit pattern backgrounds
Lightning bolt loading indicators
Copper and navy color scheme representing electrical heritage

🛠️ Technology Stack

Frontend: Flutter 3.x with null safety
State Management: Provider pattern
Backend: Firebase (Authentication, Firestore, Cloud Storage)
Navigation: go_router for type-safe routing
Weather Data: NOAA/NWS APIs (no API key required)
Maps: flutter_map with OpenStreetMap
Location: Geolocator for GPS services

📋 Prerequisites

Flutter SDK 3.6.0 or higher
Dart SDK (included with Flutter)
Firebase project configured
iOS: Xcode 14+ for iOS development
Android: Android Studio for Android development

🚀 Getting Started

Clone the repository

git clone https://github.com/yourusername/journeyman-jobs.git
cd journeyman-jobs

Install dependencies
```
flutter pub get
```
Configure Firebase
- Create a Firebase project at https://console.firebase.google.com
- Add iOS and Android apps to your Firebase project
- Download and add configuration files:
  - iOS: ios/Runner/GoogleService-Info.plist
  - Android: android/app/google-services.json

Set up environment

# Copy the example environment file
cp .env.example .env

# Add your configuration values

Run the app

# Run on iOS simulator
flutter run -d ios

# Run on Android emulator
flutter run -d android

📱 Platform Configuration

iOS Setup

The following permissions are configured in ios/Runner/Info.plist:

Location Services (for weather radar and job proximity)
Camera/Photo Library (for profile pictures)
Push Notifications (for job alerts)

Android Setup

The following permissions are configured in android/app/src/main/AndroidManifest.xml:

Fine/Coarse Location
Internet Access
Notification permissions
Camera and Storage

🏗️ Project Structure

lib/
├── main.dart                    # App entry point
├── screens/                     # Screen widgets
│   ├── home/                   # Home dashboard
│   ├── jobs/                   # Job listings and details
│   ├── storm/                  # Storm work hub with weather radar
│   ├── unions/                 # Union directory
│   └── profile/                # User profile management
├── widgets/                     # Reusable UI components
│   ├── job_card.dart          # Job listing card
│   ├── union_card.dart        # Union local card
│   └── weather/               # Weather radar components
├── services/                    # Business logic and API calls
│   ├── auth_service.dart      # Authentication
│   ├── job_service.dart       # Job data management
│   ├── location_service.dart  # GPS and location
│   ├── noaa_weather_service.dart # NOAA weather integration
│   └── notification_service.dart # Push notifications
├── models/                      # Data models
│   ├── job_model.dart         # Job posting structure
│   ├── user_model.dart        # User profile
│   └── storm_event.dart       # Storm work events
├── providers/                   # State management
│   ├── auth_provider.dart     # Authentication state
│   ├── job_provider.dart      # Job listings state
│   └── user_provider.dart     # User data state
├── design_system/              # Theme and styling
│   ├── app_theme.dart         # Colors, typography, spacing
│   └── components/            # Design system components
├── electrical_components/       # Custom electrical UI elements
└── navigation/                 # Router configuration
    └── app_router.dart        # go_router setup

🌦️ Weather Integration Details

The app integrates with multiple NOAA services for comprehensive weather tracking:

National Weather Service API: Real-time alerts and forecasts
NOAA Radar Stations: Direct radar imagery from 200+ stations
National Hurricane Center: Tropical storm tracking
Storm Prediction Center: Severe weather outlooks

All weather data is free and requires no API keys.

🧪 Testing

# Run unit tests
flutter test

# Run widget tests
flutter test test/widgets/

# Run integration tests
flutter test integration_test/

📦 Building for Production

iOS

flutter build ios --release

Android

flutter build apk --release
# or for app bundle
flutter build appbundle --release

🚀 Deployment

Manual Deployment

To deploy the Flutter web app to Firebase Hosting:

Install Firebase CLI (if not already installed):
```
npm install -g firebase-tools
```
Login to Firebase:
```
firebase login
```

Build the web app:

flutter build web --web-renderer canvaskit --release

Deploy to Firebase Hosting:
```
firebase deploy --only hosting
```
Full deployment (includes Cloud Functions, Firestore indexes, and Hosting):
```
firebase deploy
```

Prerequisites:

Ensure firebase.json is configured with hosting settings.
For full deploys, have Cloud Functions and Firestore indexes ready.
User must set up Firebase project and install dependencies.

CI/CD with GitHub Actions

The project includes automated deployment workflows:

Production Deploy: .github/workflows/firebase-hosting-merge.yml
- Triggers on push to main branch.
- Runs tests, builds web app, deploys to Firebase Hosting (live channel).
PR Previews: .github/workflows/firebase-hosting-pull-request.yml
- Triggers on pull request open/synchronize.
- Runs tests, builds web app, deploys to preview channel for review.

Setup Instructions:

In your GitHub repository, go to Settings > Secrets and variables > Actions.
Add the following repository secret:
- FIREBASE_SERVICE_ACCOUNT_JOURNEYMAN_JOBS: Paste your Firebase service account JSON key (generate from Firebase Console > Project Settings > Service Accounts).
Commit and push changes to trigger workflows.
For PR previews, Firebase will provide a unique URL in the Actions tab.

Notes:

No FIREBASE_TOKEN needed; uses service account for authentication.
Ensure Flutter cache is enabled for faster builds.
Monitor workflow runs in GitHub Actions tab.

Monitoring and Analytics

Firebase Performance Monitoring: Integrated in main.dart to track app performance (network requests, screen rendering).
Firebase Crashlytics: Set up for automatic error reporting; records fatal/non-fatal errors in services.
Firebase Analytics: Logs key events (e.g., post created, job shared) via analytics_service.dart.
Dashboards: Access via Firebase Console:
- Performance tab for traces and metrics.
- Crashlytics for crash reports.
- Analytics for user events and conversions.

Additional Setup:

Enable Performance Monitoring and Crashlytics in Firebase Console if not already.
For production, review Firebase quotas and billing.

🤝 Contributing

Fork the repository
Create your feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

📄 License

👥 Team

Development: Terragon Labs
Design: Electrical theme inspired by IBEW heritage
Weather Data: NOAA/National Weather Service

📞 Support

For support, please contact:

Technical Issues: support@journeymanjobs.com
IBEW Questions: Contact your local union

🔒 Security

All user data is encrypted in transit and at rest
Firebase Authentication handles secure login
Location data is only used for job matching and weather alerts
No personal information is shared without consent

Built with ⚡ for IBEW electrical workers