mirror of https://github.com/J3vb/OwnCord.git synced 2026-09-03 03:50:00 +03:00

Files

T

jevb cec6ca6a97 docs: add public documentation for contributors and users

Created 12 public docs derived from internal vault:
- Setup guides: quick-start, server-configuration, livekit-setup, deployment
- Networking: port-forwarding, tailscale
- References: api, protocol, schema, client-architecture
- Community: contributing, security

Updated .gitignore to only exclude docs/brain/ (internal vault),
allowing docs/ to be tracked. Updated README with expanded quick
start, voice/video setup, networking ports, and doc links.

2026-03-30 22:31:06 +02:00

2.5 KiB

Raw Blame History

Contributing

How to set up the development environment and contribute to OwnCord.

Development Setup

Prerequisites

Windows 10+ (x64)
Go 1.22+ (server)
Node.js 20+ (client)
Rust / Cargo (Tauri client)

Available Commands

Server (Go)

Command	Description
`go build -o chatserver.exe -ldflags "-s -w" .`	Build server binary
`go test ./...`	Run all server tests
`go test ./... -cover`	Run server tests with coverage
`go test -race ./...`	Run server tests with race detection

Client (Tauri v2)

Command	Description
`npm run dev`	Start Vite dev server with hot reload
`npm run build`	TypeScript check + Vite production build
`npm run tauri dev`	Launch Tauri app in dev mode
`npm run tauri build`	Build release installer
`npm test`	Run all tests (vitest)
`npm run test:unit`	Unit tests only
`npm run test:integration`	Integration tests only
`npm run test:e2e`	Playwright E2E (mocked Tauri)
`npm run test:e2e:native`	Playwright E2E (real Tauri exe + CDP)
`npm run test:e2e:prod`	Playwright E2E (prod build)
`npm run test:e2e:ui`	Playwright UI mode
`npm run test:watch`	Vitest watch mode
`npm run test:coverage`	Coverage report
`npm run typecheck`	Full typecheck (all sources)
`npm run lint`	ESLint check (src/)
`npm run lint:fix`	ESLint auto-fix

Active Branches

main -- stable releases
dev -- active development

Branch Naming

feature/<name> -- new features
fix/<name> -- bug fixes
docs/<name> -- documentation changes

Commit Format

Use conventional commits:

feat: add thread support to channels
fix: prevent duplicate WebSocket connections
refactor: extract permission checks into middleware
docs: update quick-start guide
test: add integration tests for invite flow
chore: bump Go dependencies
perf: cache role permissions in memory
ci: add lint step to GitHub Actions

Pull Request Process

Branch from dev (the active development branch)
PRs target dev; main is for stable releases only
CI must pass (build + test + lint)
Request code review
Squash merge preferred

Testing

Target 80%+ coverage. Follow test-driven development workflow.

Code Style

TypeScript: See Client Architecture
Go: gofmt + golangci-lint, standard library preferred
Rust: cargo fmt + cargo clippy, minimal code (native APIs only)

2.5 KiB Raw Blame History