ZOYKUHot Board

colibri-social/colibri.social기술 문서

colibri-social/colibri.social open-source repository on GitHub

언어 대체 안내:해당 저장소의 한국어 문서가 제공되지 않아 공식 영문 원본(English)으로 표시됩니다.
빠른 설치
git clone https://github.com/colibri-social/colibri.social.git

Colibri

Let your community spread it's wings

Colibri is an open source chat platform built on the AT Protocol for communities big and small. It gives you the ability to create communities, manage members, and communicate through text, voice, and forum channels, all while maintaining true ownership of your data.

Visit us at colibri.social. You can learn more on our about page.

Repository layout

This is a pnpm monorepo. The deployable app lives in apps/, and the code it shares lives in packages/.

Package Path Description
@colibri-social/website apps/website Marketing site, docs, and host for the web client.
@colibri-social/client packages/client The SolidJS client
@colibri-social/lib packages/lib Shared code: helpers, XRPC types, events, facets, and markdown
@colibri-social/assets packages/assets Shared static assets (fonts, sounds, logos, emoji) and their manifests.

Getting started

Prerequisites

  • Node.js ^24.13.0
  • pnpm 10.33.0 (run corepack enable to have the right one picked up automatically)

Setup

  1. Clone and install:

    git clone https://github.com/colibri-social/colibri.social.git
    cd colibri.social
    pnpm install
  2. Create a .env file in the repo root by copying .env.example.

  3. Start the client dev server:

    pnpm dev:client

    The app will be available at http://127.0.0.1:4321. You must also run the AppView development server alondside this, please see the AppView repository for more information.

Common scripts

Run from the repository root:

  • pnpm test: run the test suite (packages without tests are skipped)
  • pnpm lint: check the whole workspace with Biome
  • pnpm lint:fix: check and auto-fix
  • pnpm format: format the whole workspace with Biome
  • pnpm lexicons:export: re-export the lexicons to JSON after changing one

Contributing

Contributions are welcome! Please feel free to open issues and pull requests.

License

This project is open source. See the LICENSE file for details.

GitHub 공식 원본 저장소에서 아카이브된 문서 미러 · GitHub 저장소 방문
동기화 기준일: 2026-11-09