πŸ•ΈοΈ Ada Research Browser

README.md
← Back

CMMC Compass - Community CMMC Level 1

Quick Navigation

CMMC Compass Platform Preview

Apache 2.0 License Release Version Open Source Self-Hosted

CMMC Level 1 Compliance Manager

A comprehensive platform for managing CMMC (Cybersecurity Maturity Model Certification) Level 1 compliance requirements with AI-powered assistance and automated document processing.

✨ Features

πŸš€ Quick Start

Prerequisites

Installation

  1. Clone the repository bash git clone https://github.com/TEKIMAX/cmmc-level-1-compliance.git cd cmmc-level-1-compliance

  2. Install dependencies bash bun install

  3. Set up Convex bash bunx convex init bunx convex deploy

  4. Configure environment variables bash cp .env.example .env.local # Edit .env.local with your configuration

  5. Start development servers bash bun run dev

πŸ”§ Environment Variables

Required Local Variables (.env.local)

# Convex Configuration (Required)
CONVEX_DEPLOY_KEY=project:your_team:your_project|your_deploy_key_here
CONVEX_DEPLOYMENT=dev:your-deployment-name
VITE_CONVEX_URL=https://your-deployment-name.convex.cloud

# Auth Configuration
CONVEX_SITE_URL=http://localhost:5176

# Ollama Configuration (for local AI)
OLLAMA_API_PORT=3002
OLLAMA_BASE_URL=http://localhost:11434

Convex Deployment Variables

These should be set in your Convex dashboard or via CLI:

# OpenAI Integration (Optional - for enhanced AI features)
CONVEX_OPENAI_API_KEY=sk-your_openai_api_key_here
OPENAI_API_TOKEN=sk-your_openai_api_key_here

# OpenAI Proxy (if using)
CONVEX_OPENAI_BASE_URL=https://your-proxy-url.convex.site/openai-proxy

# Email Integration (Optional - for notifications)
CONVEX_RESEND_API_KEY=your_resend_api_key_here
RESEND_BASE_URL=https://your-proxy-url.convex.site/resend-proxy

# JWT Configuration (for auth)
JWKS={"keys":[...]}
JWT_PRIVATE_KEY=-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----

# Site URL
SITE_URL=http://localhost:5173

Setting Convex Environment Variables

You can set environment variables in your Convex deployment using:

# Via CLI
bunx convex env set VARIABLE_NAME "value"

# Via Dashboard
# Go to https://dashboard.convex.dev/ β†’ Your Project β†’ Settings β†’ Environment Variables

πŸ€– AI Configuration

  1. Install Ollama ```bash # macOS brew install ollama

# Linux curl -fsSL https://ollama.ai/install.sh | sh ```

  1. Pull required models ```bash # For text generation ollama pull llama3.2:latest

# For embeddings ollama pull mxbai-embed-large:latest ```

  1. Start Ollama server bash ollama serve

Option 2: OpenAI Integration

  1. Get OpenAI API Key
  2. Visit OpenAI API
  3. Create a new API key

  4. Set environment variable bash bunx convex env set CONVEX_OPENAI_API_KEY "sk-your_api_key_here"

πŸ“‹ CMMC Level 1 Controls Included

The platform includes all 17 official CMMC Level 1 controls as defined in the CMMC Self-Assessment Guide v2.0:

Access Control (AC) - 4 controls

Identification & Authentication (IA) - 2 controls

Media Protection (MP) - 1 control

Physical Protection (PE) - 4 controls

System & Communications Protection (SC) - 2 controls

System & Information Integrity (SI) - 4 controls

Note: These controls are based on the official CMMC Self-Assessment Guide Level 1 v2.0 and represent the complete baseline requirements for CMMC Level 1 certification.

🀝 WHO We Are

Built by Small Business Owners, For Small Business Owners

We are Tekimax LLC, a small technology business that went through CMMC Level 1 compliance ourselves. When we couldn't find affordable, privacy-focused compliance tools designed for small businesses, we built our own. Instead of keeping it proprietary, we open-sourced it under the Apache 2.0 license so the entire small business community can benefit.

Our Story

🎯 WHAT This Platform Provides

Complete CMMC Level 1 Compliance Management

Core Features

Why We Built This

We chose the Apache 2.0 license because: - βœ… Maximum Freedom: Use commercially without restrictions - βœ… Patent Protection: Includes explicit patent grants - βœ… Attribution: Simple requirements that respect contributors - βœ… Enterprise Friendly: Compatible with most corporate policies

πŸ—οΈ Architecture & Deployment

Self-Hosting Options

  1. Convex Self-Hosted (Recommended)
  2. Complete data sovereignty
  3. Enterprise-grade security
  4. Full feature compatibility

  5. Convex Cloud (Alternative)

  6. Faster setup for development
  7. Still maintains data privacy
  8. Easy migration to self-hosted later

Technology Stack

🀝 Contributing

We welcome contributions from the small business community! Here's how you can help:

Ways to Contribute

Development Setup

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Test thoroughly
  5. Submit a pull request

πŸ“„ License & Disclaimer

Apache 2.0 License

This project is licensed under the Apache License, Version 2.0 - see the LICENSE file for details.

Disclaimer

Apache 2.0 License: This software is provided "as is" without warranty of any kind. Use at your own risk. We built this during our own CMMC journey and share it freely with the community.

Not Legal Advice: This platform is a tool to help organize your compliance efforts. It does not constitute legal or compliance advice. Always consult with qualified CMMC assessors and legal professionals for your specific situation.

πŸ†˜ Support

About Convex Open Source

CMMC Compass is built to run on Convex, a modern open source backend platform. For privacy, compliance, and full control, we recommend self-hosting Convex using their open source backend:

Convex is released under the FSL Apache 2.0 License and is actively maintained by the Convex team and community. For more details, see the Convex Open Source page.

πŸ—ΊοΈ Roadmap & TODOs

πŸ› οΈ Immediate TODOs (Contributors Welcome!)

🎯 Priority

πŸ“š Learning & Education Focus

🀝 Community Features

πŸŽ“ TEKIMAX's Teaching Mission

"AI should empower through education, not intimidate through complexity ."

Every feature we build prioritizes: - Learning over compliance checking - Understanding why, not just what - Empowerment through knowledge - Building cybersecurity expertise - Community-driven education - Learning from peers and experts - Practical application - Bridging theory to real-world implementation

🌟 How to Contribute to Our Teaching Mission

  1. Educational Content Creation
  2. Create visual guides for complex concepts
  3. Develop interactive learning experiences

  4. Community Building

  5. Help other small businesses in discussions
  6. Share your implementation experiences
  7. Mentor newcomers to cybersecurity

  8. Feature Development

  9. Focus on features that teach, not just track
  10. Build tools that explain concepts clearly
  11. Create engaging learning experiences

  12. Documentation Improvements

  13. Write clear, beginner-friendly guides
  14. Add examples and real-world scenarios
  15. Improve accessibility for non-technical users

Built with ❀️ by small business owners, for small business owners.

"We've been through the CMMC journey ourselves. This tool represents everything we wish we had when we started."