Skip to content

pinkycollie/deaf-first-platform

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

167 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

CodeQL Coverage Copilot code review

MBTQ Deaf-First Platform

A comprehensive platform built with deaf-first principles, providing accessible financial services, AI-powered assistance, and decentralized governance.

πŸ“š MBTQ Components

This repository contains OpenAPI specifications for all five core services of the MBTQ.dev:

1. DeafAUTH - Identity Cortex

Secure authentication system designed with deaf-first principles.

  • Location: services/deafauth/
  • Base URL: https://api.mbtq.dev/auth auth.mbtq.dev
  • Documentation: DeafAUTH README
  • OpenAPI Spec: openapi.yaml

2. PinkSync - Accessibility Engine

Real-time accessibility features and synchronization.

  • Location: services/pinksync/
  • Base URL: https://api.mbtq.dev/syncsync.mbtq.dev
  • Documentation: PinkSync README
  • OpenAPI Spec: openapi.yaml

3. Fibonrose - Trust & Blockchain

Decentralized trust and verification layer.

  • Location: services/fibonrose/
  • Base URL: https://api.mbtq.dev/trust trust.mbtq.dev
  • Documentation: Fibonrose README
  • OpenAPI Spec: openapi.yaml

4. 360Magicians - AI Agents

Intelligent automation and assistance agents.

5. MBTQ DAO - Governance

Decentralized governance and community management.

  • Location: services/dao/
  • Base URL: https://api.mbtq.dev/dao
  • Documentation: DAO README
  • OpenAPI Spec: openapi.yaml

πŸš€ Features

βœ” All endpoints documented with OpenAPI 3.1
βœ” Standardized responses across all services
βœ” Shared DeafAUTH paseto security scheme
βœ” Tags, components, pagination, error schemas
βœ” Cloudflare-friendly JSON-only style
βœ” Automated API testing with Jest
βœ” SDK generation (TypeScript + Python)
βœ” Interactive HTML documentation
βœ” Fetch API examples for browsers
βœ” Architecture documentation
βœ” Production-ready specifications

πŸ“– Documentation

Quick Links

Generate HTML Documentation

npm run generate:docs     # Generate interactive HTML docs
npm run docs:serve        # Serve docs at http://localhost:3000

πŸ” Authentication

All MBTQ Universe services use DeafAUTH for authentication. Include the Bearer token in the Authorization header:

Authorization: Bearer <your_token>

Getting Started with Authentication

  1. Register a new user:
curl -X POST https://api.mbtq.dev/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "password": "secure_password"}'
  1. Login to get tokens:
curl -X POST https://api.mbtq.dev/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "password": "secure_password"}'
  1. Use the access token for API calls:
curl -X GET https://api.mbtq.dev/sync/status \
  -H "Authorization: Bearer <your_access_token>"

πŸ“¦ API Endpoints Overview

Note: The endpoints below show full paths including the service prefix (e.g., /auth/, /sync/). In the OpenAPI specifications, these are defined as relative paths (e.g., /register, /status) with the base URL specified in the servers section.

DeafAUTH Endpoints

  • POST /auth/register - User registration
  • POST /auth/login - User authentication
  • GET /auth/verify - Token verification
  • POST /auth/refresh - Token refresh

PinkSync Endpoints

  • GET /sync/status - Check synchronization status
  • POST /sync/preferences - Update accessibility preferences
  • GET /sync/features - List available accessibility features

Fibonrose Endpoints

  • POST /trust/blockchain/verify - Verify blockchain transaction
  • GET /trust//trust-score - Get trust score
  • POST /trust/blockchain/record - Record new transaction

360Magicians Endpoints

Comprehensive AI agent platform with 60+ endpoints including:

  • Agent management (CRUD operations)
  • Task execution and workflow orchestration
  • Memory and context management
  • File ingestion and RAG search
  • Tool registration and management
  • Scheduling and webhooks
  • Analytics and cost tracking

See 360Magicians README for complete endpoint list.

DAO Endpoints

  • GET /dao/proposals - List governance proposals
  • POST /dao/vote - Submit vote
  • GET /dao/members - List DAO members

πŸ”§ Environment Configuration

Copy .env.example to .env and configure your environment variables:

cp .env.example .env

See .env.example for all required configuration options.

🌐 Integration Notes

Google API & AI SDKs

Google Cloud Integration:

  • Google Cloud Vision API for visual accessibility features
  • Google Speech-to-Text for real-time captioning
  • Google Translate API for multi-language support
  • PinkSync API acts as an API broker network for partners' APIs that enhance deaf accessibility

AI SDK Integration:

The platform uses multiple AI models for comprehensive coverage:

  • OpenAI: GPT-4, GPT-4 Turbo for natural language processing
  • Anthropic: Claude 3 for advanced reasoning
  • Google: Gemini Pro for multimodal tasks
  • TensorFlow.js: Client-side AI processing
  • Hugging Face Transformers: Specialized accessibility models

πŸ”„ Integration with Other Repositories

This platform integrates with several related repositories:

πŸ§ͺ Testing & Validation

Automated API Testing

Run comprehensive API tests for all services:

# Install dependencies
npm install

# Run all tests
npm test

# Run tests with coverage
npm run test:coverage

# Run specific service tests
npm test -- tests/deafauth
npm test -- tests/pinksync
npm test -- tests/magicians

See tests/README.md for detailed testing documentation.

OpenAPI Validation

Validate all OpenAPI specifications:

# Validate specs
npm run validate:openapi

All specifications are validated and ready for:

  • Documentation generation
  • SDK generation (TypeScript, Python, Go, etc.)
  • API gateway configuration
  • Testing and mocking

SDK Generation

Generate client SDKs from OpenAPI specifications:

# Generate TypeScript SDK
npm run generate:sdk:typescript

# Generate Python SDK
npm run generate:sdk:python

# Generate all SDKs
npm run generate:sdk

Generated SDKs will be in the sdks/ directory. See SDK.md for detailed documentation and usage examples.

πŸ“š Middleware Examples

DeafAUTH Middleware (Node.js/Express)

const deafAuthMiddleware = async (req, res, next) => {
  const token = req.headers.authorization?.split(' ')[1];
  
  if (!token) {
    return res.status(401).json({ error: 'No token provided' });
  }
  
  try {
    const decoded = await verifyDeafAuthToken(token);
    req.user = decoded;
    next();
  } catch (error) {
    return res.status(403).json({ error: 'Invalid token' });
  }
};

module.exports = deafAuthMiddleware;

PinkSync Middleware (Node.js/Express)

const pinkSyncMiddleware = async (req, res, next) => {
  const userId = req.user?.id;
  
  if (userId) {
    const preferences = await getPinkSyncPreferences(userId);
    req.accessibilityPrefs = preferences;
  }
  
  next();
};

module.exports = pinkSyncMiddleware;

🎯 Quick Start for Developers

1. Clone and Install

# Clone the repository
git clone https://github.com/pinkycollie/DEAF-FIRST-PLATFORM.git
cd DEAF-FIRST-PLATFORM

# Install dependencies
npm install

2. Validate OpenAPI Specifications

npm run validate:openapi

3. Run Tests

# Run all tests
npm test

# Run with coverage
npm run test:coverage

4. Generate SDKs

# Generate TypeScript SDK
npm run generate:sdk:typescript

# Generate Python SDK
npm run generate:sdk:python

5. Use Generated SDKs

See SDK.md for usage examples with TypeScript and Python.

🎯 Next Steps

Generate Documentation

Generate interactive API documentation:

# TypeScript SDK
openapi-generator-cli generate \
  -i services/deafauth/openapi/openapi.yaml \
  -g typescript-axios \
  -o sdks/typescript/deafauth

# Python SDK
openapi-generator-cli generate \
  -i services/deafauth/openapi/openapi.yaml \
  -g python \
  -o sdks/python/deafauth

Option 2: Deploy with Cloudflare Workers

Each service can be deployed as a Cloudflare Worker for edge computing benefits.

Option 3: Generate API Documentation

Use Redoc, Swagger UI, or other documentation tools to generate interactive API documentation.

Option 4: Set Up CI/CD

Implement automated testing, validation, and deployment for all services.

πŸ“– Additional Documentation

🀝 Contributing

Contributions are welcome! Please ensure all changes maintain accessibility standards and deaf-first principles.

πŸ“„ License

See LICENSE file for details.

🌟 Acknowledgments

Built with deaf-first principles and a commitment to accessibility for all.

DEAF-FIRST Platform

CI/CD Pipeline Security Scanning Deploy to GitHub Pages License: MIT Node Version TypeScript Accessibility

A deaf-first SaaS ecosystem with AI-powered workflows and comprehensive accessibility features.

🌐 View Live Demo on GitHub Pages

Overview

The DEAF-FIRST Platform is a monorepo containing multiple services designed with accessibility as the primary focus. It includes authentication, real-time synchronization, AI workflows, and specialized accessibility nodes.

The platform features a modern, cutting-edge showcase interface that demonstrates all services and capabilities. See GITHUB-PAGES-SETUP.md for deployment details.

🎯 Key Features

  • β™Ώ Accessibility First: WCAG 2.1 AAA compliant design throughout
  • πŸ” Secure Authentication: JWT-based auth with DeafAUTH service
  • πŸ”„ Real-time Sync: WebSocket-based synchronization with PinkSync
  • πŸ“Š AI-Powered: OpenAI integration for intelligent workflows
  • πŸ—οΈ Microservices Architecture: Independent, scalable services
  • πŸš€ CI/CD Pipeline: Automated testing, security scans, and deployment
  • 🐳 Docker Ready: Full containerization support
  • ☁️ Infrastructure as Code: Terraform templates included

πŸ“š Documentation

Architecture

This is a monorepo managed with npm workspaces containing:

  • frontend: React-based accessible user interface
  • backend: Express API server
  • services/deafauth: DeafAUTH authentication service with MCP server support
  • services/pinksync: Real-time synchronization service
  • services/fibonrose: Mathematical optimization engine
  • services/accessibility-nodes: Modular accessibility features
  • ai: AI services for deaf-first workflows

Prerequisites

  • Node.js >= 20.0.0
  • npm >= 10.0.0
  • PostgreSQL (for backend and deafauth)
  • Redis (for pinksync)

Quick Start

  1. Clone the repository:
git clone https://github.com/pinkycollie/Deaf-First-Platform.git
cd Deaf-First-Platform
  1. Install dependencies:
npm install
  1. Set up environment variables:
cp .env.example .env
# Edit .env with your configuration
  1. Run all services in development mode:
npm run dev

Development Scripts

Run all services

npm run dev

Run individual services

npm run dev:frontend    # Frontend only
npm run dev:backend     # Backend only
npm run dev:deafauth    # DeafAUTH only
npm run dev:pinksync    # PinkSync only
npm run dev:fibonrose   # FibonRose only
npm run dev:a11y        # Accessibility nodes only

Build

npm run build           # Build all workspaces

Testing

npm run test            # Run all tests
npm run test:e2e        # Run end-to-end tests

Code Quality

npm run lint            # Lint all workspaces
npm run format          # Format code with Prettier
npm run type-check      # TypeScript type checking

Database

npm run db:setup        # Setup databases
npm run db:migrate      # Run migrations
npm run db:seed         # Seed databases

Docker

npm run docker:up       # Start all services with Docker
npm run docker:down     # Stop Docker services
npm run docker:logs     # View Docker logs
npm run build:docker    # Build Docker images

Webhook System

The platform includes a comprehensive webhook system for real-time event notifications:

# Start backend with webhook support
npm run dev:backend

# Access webhook API at http://localhost:3000/api/webhooks

Features:

  • Register and manage webhooks via REST API
  • Receive webhooks from external services (Xano, Stripe, etc.)
  • HMAC-SHA256 signature verification
  • 12 predefined event types (user, auth, document, accessibility, sync, AI)
  • Webhook delivery tracking and history
  • Test endpoints for development

Documentation:

MCP Server Support

The platform includes Model Context Protocol (MCP) server support in several services:

  • DeafAUTH: Authentication and user management
  • PinkSync: Real-time data synchronization
  • FibonRose: Mathematical optimization
  • Accessibility Nodes: Accessibility features API
  • AI Services: AI-powered workflows

To run MCP servers individually:

npm run mcp --workspace=services/deafauth
npm run mcp --workspace=services/pinksync
npm run mcp --workspace=services/fibonrose
npm run mcp --workspace=services/accessibility-nodes
npm run mcp --workspace=ai

Workspaces

Each workspace is independently versioned and can be developed, tested, and deployed separately.

Frontend (@deaf-first/frontend)

  • React 18 with TypeScript
  • Vite for fast development
  • Accessible UI components
  • Sign language support

Backend (@deaf-first/backend)

  • Express.js REST API
  • PostgreSQL database
  • JWT authentication
  • RESTful endpoints

DeafAUTH (@mbtq/deafauth)

  • Specialized authentication service
  • Accessible authentication flows
  • MCP server for auth operations
  • User preference management

PinkSync (@mbtq/pinksync)

  • Real-time WebSocket synchronization
  • Redis-based pub/sub
  • MCP server for sync operations
  • Event-driven architecture

FibonRose (@mbtq/fibonrose)

  • Mathematical optimization algorithms
  • Fibonacci-based scheduling
  • MCP server for optimization queries
  • Performance analytics

Accessibility Nodes (@mbtq/accessibility-nodes)

  • Modular accessibility features
  • Sign language interpretation
  • Visual accessibility enhancements
  • MCP server for accessibility APIs

AI Services (@mbtq/ai)

  • AI-powered workflows
  • Natural language processing
  • Sign language generation
  • MCP server for AI operations

Environment Variables

Create a .env file in the root directory:

# Database
DATABASE_URL=postgresql://user:password@localhost:5432/deafirst
DEAFAUTH_DATABASE_URL=postgresql://user:password@localhost:5432/deafauth

# Redis
REDIS_URL=redis://localhost:6379

# JWT
JWT_SECRET=your-secret-key
JWT_EXPIRY=7d

#Paseto

# Frontend
VITE_API_URL=http://localhost:3000
VITE_WS_URL=ws://localhost:3001

# Services Pending
DEAFAUTH_PORT=3002
PINKSYNC_PORT=3003
FIBONROSE_PORT=3004
A11Y_PORT=3005
AI_PORT=8###

# MagicianCore Services
OPENAI_API_KEY=your-openai-key

# Webhook Configuration
WEBHOOK_SECRET=your-webhook-secret-key-here

Contributing

We welcome contributions! Please read our CONTRIBUTING.md guide before submitting PRs.

Quick Contribution Steps

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes following our code standards
  4. Run tests and linting (npm run lint && npm run test)
  5. Commit your changes (git commit -m 'feat: add amazing feature')
  6. Push to your branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

Development Guidelines

  • Follow the Conventional Commits specification
  • Maintain WCAG 2.1 AAA accessibility compliance
  • Write tests for new features
  • Update documentation as needed
  • Ensure all CI checks pass

License

MIT License - see LICENSE file for details

Author

360 Magicians

Keywords

  • Deaf-first design
  • Accessibility
  • SaaS ecosystem
  • modules workflows
  • http platform management
  • Real-time synchronization
  • Sign language support =======

MBTQ Deaf-First Platform

A comprehensive platform built with deaf-first principles, providing accessible financial services, AI-powered assistance, and decentralized governance.

πŸ“š MBTQ Universe Components

This repository contains OpenAPI specifications for all five core services of the MBTQ Universe:

1. DeafAUTH - Identity Cortex

Secure authentication system designed with deaf-first principles.

2. PinkSync - Accessibility Engine

Real-time accessibility features and synchronization.

3. Fibonrose - Trust & Blockchain

Decentralized trust and verification layer.

  • Location: services/fibonrose/
  • Base URL: https://api.mbtquniverse.com/blockchain
  • Documentation: Fibonrose README
  • OpenAPI Spec: openapi.yaml

4. 360Magicians - AI Agents

Intelligent automation and assistance agents.

5. MBTQ DAO - Governance

Decentralized governance and community management.

  • Location: services/dao/
  • Base URL: https://api.mbtquniverse.com/dao
  • Documentation: DAO README
  • OpenAPI Spec: openapi.yaml

πŸš€ Features

βœ” All endpoints documented with OpenAPI 3.1
βœ” Standardized responses across all services
βœ” Shared DeafAUTH security scheme
βœ” Tags, components, pagination, error schemas
βœ” Cloudflare-friendly JSON-only style
βœ” Automated API testing with Jest
βœ” SDK generation (TypeScript + Python)
βœ” Production-ready specifications

πŸ” Authentication

All MBTQ Universe services use DeafAUTH for authentication. Include the Bearer token in the Authorization header:

Authorization: Bearer <your_token>

Getting Started with Authentication

  1. Register a new user:
curl -X POST https://api.mbtquniverse.com/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "password": "secure_password"}'
  1. Login to get tokens:
curl -X POST https://api.mbtquniverse.com/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "password": "secure_password"}'
  1. Use the access token for API calls:
curl -X GET https://api.mbtquniverse.com/sync/status \
  -H "Authorization: Bearer <your_access_token>"

πŸ“¦ API Endpoints Overview

Note: The endpoints below show full paths including the service prefix (e.g., /auth/, /sync/). In the OpenAPI specifications, these are defined as relative paths (e.g., /register, /status) with the base URL specified in the servers section.

DeafAUTH Endpoints

  • POST /auth/register - User registration
  • POST /auth/login - User authentication
  • GET /auth/verify - Token verification
  • POST /auth/refresh - Token refresh

PinkSync Endpoints

  • GET /sync/status - Check synchronization status
  • POST /sync/preferences - Update accessibility preferences
  • GET /sync/features - List available accessibility features

Fibonrose Endpoints

  • POST /blockchain/verify - Verify blockchain transaction
  • GET /blockchain/trust-score - Get trust score
  • POST /blockchain/record - Record new transaction

360Magicians Endpoints

Comprehensive AI agent platform with 60+ endpoints including:

  • Agent management (CRUD operations)
  • Task execution and workflow orchestration
  • Memory and context management
  • File ingestion and RAG search
  • Tool registration and management
  • Scheduling and webhooks
  • Analytics and cost tracking

See 360Magicians README for complete endpoint list.

DAO Endpoints

  • GET /dao/proposals - List governance proposals
  • POST /dao/vote - Submit vote
  • GET /dao/members - List DAO members

πŸ”§ Environment Configuration

Copy .env.example to .env and configure your environment variables:

cp .env.example .env

See .env.example for all required configuration options.

🌐 Integration Notes

Google API & AI SDKs

Google Cloud Integration:

  • Google Cloud Vision API for visual accessibility features
  • Google Speech-to-Text for real-time captioning
  • Google Translate API for multi-language support
  • PinkSync API acts as an API broker network for partners' APIs that enhance deaf accessibility

AI SDK Integration:

The platform uses multiple AI models for comprehensive coverage:

  • OpenAI: GPT-4, GPT-4 Turbo for natural language processing
  • Anthropic: Claude 3 for advanced reasoning
  • Google: Gemini Pro for multimodal tasks
  • TensorFlow.js: Client-side AI processing
  • Hugging Face Transformers: Specialized accessibility models

πŸ”„ Integration with Other Repositories

This platform integrates with several related repositories:

πŸ§ͺ Testing & Validation

Automated API Testing

Run comprehensive API tests for all services:

# Install dependencies
npm install

# Run all tests
npm test

# Run tests with coverage
npm run test:coverage

# Run specific service tests
npm test -- tests/deafauth
npm test -- tests/pinksync
npm test -- tests/magicians

See tests/README.md for detailed testing documentation.

OpenAPI Validation

Validate all OpenAPI specifications:

# Validate specs
npm run validate:openapi

All specifications are validated and ready for:

  • Documentation generation
  • SDK generation (TypeScript, Python, Go, etc.)
  • API gateway configuration
  • Testing and mocking

SDK Generation

Generate client SDKs from OpenAPI specifications:

# Generate TypeScript SDK
npm run generate:sdk:typescript

# Generate Python SDK
npm run generate:sdk:python

# Generate all SDKs
npm run generate:sdk

Generated SDKs will be in the sdks/ directory. See SDK.md for detailed documentation and usage examples.

πŸ“š Middleware Examples

DeafAUTH Middleware (Node.js/Express)

const deafAuthMiddleware = async (req, res, next) => {
  const token = req.headers.authorization?.split(' ')[1];
  
  if (!token) {
    return res.status(401).json({ error: 'No token provided' });
  }
  
  try {
    const decoded = await verifyDeafAuthToken(token);
    req.user = decoded;
    next();
  } catch (error) {
    return res.status(403).json({ error: 'Invalid token' });
  }
};

module.exports = deafAuthMiddleware;

PinkSync Middleware (Node.js/Express)

const pinkSyncMiddleware = async (req, res, next) => {
  const userId = req.user?.id;
  
  if (userId) {
    const preferences = await getPinkSyncPreferences(userId);
    req.accessibilityPrefs = preferences;
  }
  
  next();
};

module.exports = pinkSyncMiddleware;

🎯 Quick Start for Developers

1. Clone and Install

# Clone the repository
git clone https://github.com/pinkycollie/DEAF-FIRST-PLATFORM.git
cd DEAF-FIRST-PLATFORM

# Install dependencies
npm install

2. Validate OpenAPI Specifications

npm run validate:openapi

3. Run Tests

# Run all tests
npm test

# Run with coverage
npm run test:coverage

4. Generate SDKs

# Generate TypeScript SDK
npm run generate:sdk:typescript

# Generate Python SDK
npm run generate:sdk:python

5. Use Generated SDKs

See SDK.md for usage examples with TypeScript and Python.

🎯 Next Steps

Generate Documentation

Generate interactive API documentation:

# TypeScript SDK
openapi-generator-cli generate \
  -i services/deafauth/openapi/openapi.yaml \
  -g typescript-axios \
  -o sdks/typescript/deafauth

# Python SDK
openapi-generator-cli generate \
  -i services/deafauth/openapi/openapi.yaml \
  -g python \
  -o sdks/python/deafauth

Option 2: Deploy with Cloudflare Workers

Each service can be deployed as a Cloudflare Worker for edge computing benefits.

Option 3: Generate API Documentation

Use Redoc, Swagger UI, or other documentation tools to generate interactive API documentation.

Option 4: Set Up CI/CD

Implement automated testing, validation, and deployment for all services.

πŸ“– Additional Documentation

🀝 Contributing

Contributions are welcome! Please ensure all changes maintain accessibility standards and deaf-first principles.

πŸ“„ License

See LICENSE file for details.

🌟 Acknowledgments

Built with deaf-first principles and a commitment to accessibility for all.

e961430

About

monorepo containing multiple services designed with accessibility as the primary focus. It includes authentication, real-time synchronization, AI workflows, and specialized accessibility nodes.

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors