Skip to main content

​
Contributing

Contributions to the Collabase community edition are welcome. By contributing you agree that your code will be licensed under BSL 1.1.

Repository

View the source code

License

BSL 1.1 terms and limits

Code of conduct

Our community guidelines

Contributing guide

Technical PR guidelines

​
Ecosystem architecture

Collabase spans multiple repositories and package architectures, balancing our open BSL 1.1 core model with MIT-licensed developer tools and our proprietary enterprise packages. 
┌──────────────────────────────────────────────────────────────┐
│                    Collabase Ecosystem                       │
├──────────────────────────────┬───────────────────────────────┤
│       BSL 1.1 (Public)       │     Proprietary (Private)     │
│                              │                               │
│ collabase-core               │ collabase-enterprise          │
│ ├─ Wiki                      │ ├─ SAML SSO                   │
│ ├─ Tasks                     │ ├─ SCIM 2.0                   │
│ ├─ Docs                      │ ├─ LDAP / AD                  │
│ ├─ Automation                │ ├─ OAuth Enterprise           │
│ ├─ Intranet                  │ │  (Okta, Keycloak, AzureAD)  │
│ ├─ Registry                  │ ├─ Security Policies          │
│ ├─ Test Mgmt                 │ └─ Immutable Audit Log        │
│ ├─ Service Desk              │                               │
│ ├─ Time Tracking             │ Customers install via npm:    │
│ ├─ Brain / AI                │ `@collabase/enterprise`       │
│ └─ Plugin Engine             │ (token-secured)               │
├──────────────────────────────┴───────────────────────────────┤
│         MIT (Public) — Community Development Tools           │
│                                                              │
│ @collabase/sdk         @collabase/ui   @collabase/api-client │
│ ├─ defineConnector()   ├─ Button       ├─ tasks.list()       │
│ ├─ defineAction()      ├─ Table        ├─ pages.update()     │
│ └─ CollabaseApp bridge └─ Theme Tokens └─ Result<T> handler  │
│                                                              │
├──────────────────────────────────────────────────────────────┤
│          Community builds & publishes extensions             │
│                                                              │
│ @acme/collabase-crm (npm)   ← Custom Automation Connector    │
│ acme-crm-app                ← Embedded iFrame SDK App        │
│ custom.wasm                 ← High-performance WASM hook     │
│ marketplace.collabase.com   ← Free Plugin Marketplace        │
└──────────────────────────────────────────────────────────────┘

​
Development setup

1

Clone the repository

git clone https://github.com/Collabase/collabase.git
cd collabase
2

Install dependencies

npm install
3

Set up the environment

Copy .env.example to .env and fill in a PostgreSQL connection string and a NextAuth secret.
4

Run the dev server

npm run dev
The app is available at http://localhost:3000.

​
Pull request guidelines

  • Open an issue before starting significant work.
  • Use conventional commits: feat:, fix:, refactor:, chore:.
  • New logic in src/services/ requires unit tests (at least 80% coverage).
  • No hardcoded UI strings — use the i18n dictionary.