Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
91 lines (79 loc) · 2.98 KB

CONTRIBUTING.md

File metadata and controls

91 lines (79 loc) · 2.98 KB
Raw

Contributing to KeyWrit Hub

Prerequisites

  • Bun (latest version)

Setup

git clone https://github.com/keywrit/KeyWrit-Hub.git
cd KeyWrit-Hub
bun install

Development Commands

bun run dev           # Start development server
bun run build         # Build for production
bun run preview       # Preview production build
bun run test          # Run tests (watch mode)
bun run test:run      # Run tests once
bun run test:coverage # Run tests with coverage
bun run typecheck     # Type check with TypeScript
bun run lint          # Run linter and formatter
bun run lint:fix      # Auto-fix linting and formatting issues
bun run check         # Run all checks (lint + typecheck + tests)

Project Structure

src/
├── App.tsx              # Main application component
├── main.tsx             # Entry point
├── index.css            # Global styles (Tailwind)
├── components/
│   ├── client/          # Client management components
│   │   ├── ClientCard.tsx
│   │   ├── ClientForm.tsx
│   │   ├── ClientList.tsx
│   │   ├── ClientSelector.tsx
│   │   └── ManageClientDialog.tsx
│   ├── layout/          # Layout components
│   │   ├── Header.tsx
│   │   ├── Sidebar.tsx
│   │   └── ThemeToggle.tsx
│   ├── license/         # License management components
│   │   ├── LicenseCard.tsx
│   │   ├── LicenseForm.tsx
│   │   ├── LicenseList.tsx
│   │   └── LicenseSection.tsx
│   ├── realm/           # Realm management components
│   │   ├── ExportDialog.tsx
│   │   ├── ImportDialog.tsx
│   │   ├── RealmCard.tsx
│   │   ├── RealmForm.tsx
│   │   └── RealmList.tsx
│   └── ui/              # shadcn/ui components
├── context/
│   ├── RealmContext.tsx # Realm state management
│   └── ThemeContext.tsx # Theme state management
├── hooks/
│   ├── useRealms.ts     # Hook for realm context
│   └── useTheme.ts      # Hook for theme context
└── lib/
    ├── crypto/
    │   └── keys.ts      # Key pair generation with jose
    ├── storage/
    │   ├── migrations.ts # Schema versioning
    │   └── storage.ts   # localStorage operations
    ├── jwt.ts           # JWT generation with jose
    ├── license.ts       # License utilities
    ├── types.ts         # TypeScript interfaces
    └── utils.ts         # Utility functions (cn helper)

Code Style

  • TypeScript with strict mode
  • Follow existing patterns in the codebase
  • Use the @ path alias for imports from src/
  • Use the cn() utility for combining Tailwind classes

Pull Request Process

  1. Fork the repository
  2. Create a feature branch from main
  3. Make your changes
  4. Run bun run check to verify linting, types, and tests pass
  5. Submit a pull request with a clear description