Merge pull request #2 from intelliDean/rev

observability added and cleanup up

Author: intelliDean

.env.example

@@ -1,33 +1,42 @@
-# Environment Variables Template
-# Copy this file to .env and fill in your actual values
-# NEVER commit .env to version control
-
-# Database Configuration
-DATABASE_URL=postgresql://username:password@localhost/payego
-
-# JWT Configuration
-JWT_SECRET=your_jwt_secret_min_32_characters_long_change_this_in_production
-JWT_EXPIRATION_HOURS=2
-
 # Server Configuration
-HOST=127.0.0.1
+HOST=0.0.0.0
 PORT=8080
-APP_URL=http://localhost:8080
-APP_ENV=development
-
-# CORS Configuration (comma-separated list)
-CORS_ORIGINS=http://localhost:5173,http://localhost:3000
-
-# Payment Gateway Keys
-# Stripe: Get from https://dashboard.stripe.com/test/apikeys
-STRIPE_SECRET_KEY=sk_test_your_stripe_secret_key_here
-
-# PayPal: Get from https://developer.paypal.com/dashboard/applications
-PAYPAL_CLIENT_ID=your_paypal_client_id_here
-PAYPAL_SECRET=your_paypal_secret_here
-
-# Paystack: Get from https://dashboard.paystack.com/#/settings/developer
-PAYSTACK_SECRET_KEY=sk_test_your_paystack_secret_key_here
-
-# Logging Configuration
+APP_PORT=8081
+CORS_ORIGINS=*
 RUST_LOG=info
+
+# Database Configuration
+# Internal URL for Docker: postgres://postgres:password@db:5432/payego
+# External URL for Local Development: postgres://postgres:password@localhost:5434/payego
+DATABASE_URL=postgres://postgres:password@localhost:5434/payego
+DB_USER=postgres
+DB_PASSWORD=password
+DB_NAME=payego
+DB_PORT=5434
+
+# Security
+JWT_SECRET=your_32_character_long_secret_here_min_length
+JWT_EXPIRATION_HOURS=24
+ISSUER=payego-api
+AUDIENCE=payego-client
+
+# Stripe Details
+STRIPE_SECRET_KEY=sk_test_...
+STRIPE_WEBHOOK_SECRET=whsec_...
+STRIPE_API_URL=https://api.stripe.com
+
+# Paystack Details
+PAYSTACK_SECRET_KEY=sk_test_...
+PAYSTACK_WEBHOOK_SECRET=your_paystack_webhook_token
+PAYSTACK_API_URL=https://api.paystack.co
+
+# PayPal Details
+PAYPAL_CLIENT_ID=your_paypal_client_id
+PAYPAL_SECRET=your_paypal_secret
+PAYPAL_API_URL=https://api-m.sandbox.paypal.com
+
+# Other Configs
+APP_URL=http://localhost:8080
+FEE_BPS=100
+EXCHANGE_API_URL=https://api.exchangerate-api.com/v4/latest
+DEFAULT_COUNTRY=Nigeria

.github/workflows/cd.yml

@@ -0,0 +1,44 @@
+name: CD
+
+on:
+  push:
+    branches: [ "main" ]
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=raw,value=latest
+            type=sha,format=short
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/ci.yml

@@ -0,0 +1,111 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main", "master" ]
+  pull_request:
+    branches: [ "main", "master" ]
+
+env:
+  CARGO_TERM_COLOR: always
+  SQLX_OFFLINE: true
+
+jobs:
+  backend:
+    name: Backend (Rust)
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:15-alpine
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: password
+          POSTGRES_DB: payego
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          components: clippy, rustfmt
+
+      - name: Cache Cargo registry
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cargo/bin/
+            ~/.cargo/registry/index/
+            ~/.cargo/registry/cache/
+            ~/.cargo/git/db/
+            target/
+          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}
+
+      - name: Install dependencies
+        run: sudo apt-get update && sudo apt-get install -y libpq-dev openssl libssl-dev pkg-config
+
+      - name: Install diesel_cli
+        run: |
+          if ! command -v diesel &> /dev/null; then
+            cargo install diesel_cli --no-default-features --features postgres
+          fi
+      
+      - name: Install cargo-audit
+        run: |
+          if ! command -v cargo-audit &> /dev/null; then
+             cargo install cargo-audit
+          fi
+
+      - name: Check Formatting
+        run: cargo fmt --all -- --check
+
+      - name: Linting
+        run: cargo clippy --workspace --all-targets --all-features -- -D warnings
+
+      - name: Run Tests
+        env:
+          DATABASE_URL: postgres://postgres:password@localhost:5432/payego
+          TEST_DATABASE_URL: postgres://postgres:password@localhost:5432/payego
+          APP_ENV: test
+          JWT_SECRET: super_secret_testing_key_must_be_long_enough
+          RUST_LOG: info
+        run: cargo test --workspace
+
+      - name: Security Audit
+        run: cargo audit
+
+  frontend:
+    name: Frontend (React)
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./payego_ui
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+          cache: 'npm'
+          cache-dependency-path: payego_ui/package-lock.json
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Test
+        run: npm run test
+
+      - name: Build
+        run: npm run build

CONTRIBUTING.md

@@ -0,0 +1,42 @@
+# Contributing to Payego
+
+Thank you for your interest in contributing to Payego! We welcome contributions from everyone.
+
+## Development Workflow
+
+1.  **Fork and Clone**: Fork the repository and clone it locally.
+2.  **Branching**: Create a new branch for your feature or bugfix.
+    ```bash
+    git checkout -b feature/amazing-feature
+    ```
+3.  **Backend Development**:
+    -   Code is in `src/`, `crates/`, and `bin/`.
+    -   Run tests: `cargo test`
+    -   Check linting: `cargo clippy`
+    -   Check formatting: `cargo fmt`
+4.  **Frontend Development**:
+    -   Code is in `payego_ui/`.
+    -   Run dev server: `npm run dev`
+    -   Run tests: `npm run test`
+    -   Run linting: `npm run lint`
+
+## Pull Request Process
+
+1.  Ensure all local tests pass.
+2.  Commit your changes with clear, descriptive commit messages.
+3.  Push to your fork and submit a Pull Request to the `main` branch.
+4.  Our CI pipeline will automatically run to verify your changes.
+
+## Code Style
+
+-   **Rust**: Follow standard Rust conventions (`rustfmt`).
+-   **JavaScript/React**: Follow ESLint configuration in `payego_ui`.
+
+## Architecture Guide
+
+-   **payego-api** (`crates/api`): HTTP handlers and routing.
+-   **payego-core** (`crates/core`): Business logic and services.
+-   **payego-primitives** (`crates/primitives`): Shared types, DTOs, and errors.
+-   **payego-ui** (`payego_ui`): React frontend.
+
+Happy Coding! 🚀

Cargo.lock

@@ -49,6 +49,7 @@ axum-prometheus = "0.10.0"
 strum = { version = "0.26", features = ["derive"] }
 diesel-derive-enum = { version = "2.1", features = ["postgres"] }
 thiserror = "2.0.17"
+once_cell = "1.21.3"
 
 # Workspace local dependencies
 payego-primitives = { path = "crates/primitives" }