Skip to content

trycompai/comp

Repository files navigation

Logo

Comp AI

The open-source compliance platform.
Learn more »

Discord · Website · Documentation · Issues · Roadmap

About

Security and compliance, open.

We're building the first open source compliance automation platform that helps companies of any size work towards, manage and achieve compliance with common standards like SOC 2, ISO 27001 and GDPR.

We transform compliance from a vendor checkbox into an engineering problem solved through code. Our platform automates evidence collection, policy management, and control implementation while keeping you in control of your data and infrastructure.

Built With

Contact us

Contact our founders at [email protected] to learn more about how we can help you achieve compliance.

Stay Up-to-Date

Join our waitlist to get early access to the cloud hosted version of Comp AI.

Getting Started

To get a local copy up and running, please follow these simple steps.

Prerequisites

Here is what you need to be able to run Comp AI.

  • Node.js (Version: >=20.x)
  • Bun (Version: >=1.1.36)
  • Postgres (Version: >=15.x)

Development

Setup

  1. Clone the repo into a public GitHub repository (or fork https://github.com/trycompai/comp/fork). If you modify and distribute the code, or run it as a network service, you must provide the source code to users under the terms of AGPLv3. For uses not covered by AGPLv3, a commercial license is available.

    git clone https://github.com/trycompai/comp.git
  2. Go to the project folder

    cd comp
  3. Install packages with bun

    bun i
  4. Set up your .env files

    • Copy the example environment files to create your local environment files:
    cp apps/web/.env.example apps/web/.env
    cp apps/app/.env.example apps/app/.env
    • Fill in the required environment variables in both .env files
    • Use openssl rand -base64 32 to generate a key and add it under AUTH_SECRET in the apps/app/.env file
  5. Setup Node If your Node version does not meet the project's requirements as instructed by the docs, "nvm" (Node Version Manager) allows using Node at the version required by the project:

    nvm use

    You first might need to install the specific version and then use it:

    nvm install && nvm use

    You can install nvm from here.

  6. Run the turbo dev command to start the development server

    turbo dev

Deployment

Docker

Steps to deploy Comp AI on Docker are coming soon.

Vercel

Steps to deploy Comp AI on Vercel are coming soon.

Contributors

Repo Activity

Alt

License

Comp AI, Inc. is a commercial open source company, which means some parts of this open source repository require a commercial license. The concept is called "Open Core" where the core technology (99%) is fully open source, licensed under AGPLv3 and the last 1% is covered under a commercial license (["/ee" Enterprise Edition"]).

Tip

We work closely with the community and always invite feedback about what should be open and what is fine to be commercial. This list is not set and stone and we have moved things from commercial to open in the past. Please open a discussion if you feel like something is wrong.