Skip to content

README.md

Latest commit

 

History

History
54 lines (37 loc) · 1.05 KB

README.md

File metadata and controls

54 lines (37 loc) · 1.05 KB

Flok Protocol

Protocol definitions for encrypted communities on the AT Protocol.

Overview

Flok enables the creation and management of private, encrypted communities (Floks) on Bluesky. Each Flok supports:

  • End-to-end encrypted content
  • Points-based permissions
  • Invite-only or open membership
  • Customizable thresholds for actions

Development Setup

Prerequisites

  • Node.js >= 18.0.0
  • npm

Quick Start

# Clone repository
git clone https://github.com/gtabot/flok-proto.git
cd flok-proto

# Install dependencies
npm install

# Build project
npm run build

# Validate lexicons
npm run validate

Project Structure

src/
├── lexicons/           # AT Protocol lexicon definitions
│   └── app/
│       └── flox/      # Core Flok operations
├── encrypted_schemas/  # Typescript interfaces for encrypted data
└── scripts/           # Development utilities

Contact

Built on the AT Protocol