Contributing

We welcome contributions to Fyren! Whether it's bug reports, feature requests, documentation improvements, or code changes — every contribution helps.

Getting Started

Prerequisites

• Bun (v1.1+)
• Docker and Docker Compose
• PostgreSQL 15+ (or use Docker)
• Redis 7+ (or use Docker)

Development Setup

1. Fork and clone the repository:

git clone https://github.com/fyrendev/fyren.git
cd fyren

2. Install dependencies:

bun install

3. Start the development databases:

docker compose up -d db redis

4. Copy the example environment file:

cp .env.example .env

5. Run database migrations:

bun run db:migrate

6. Start the development server:

bun run dev

Project Structure

Fyren uses a monorepo structure with Turborepo:

• apps/api — Hono API server
• apps/web — Public status page (Next.js)
• apps/admin — Admin dashboard (Next.js)
• packages/db — Drizzle schema and migrations
• packages/shared — Shared types, validation, and utilities

Guidelines

Code Style

• TypeScript strict mode is enabled
• Use Prettier for formatting (bun run format)
• Follow existing patterns in the codebase

Commits

Use Conventional Commits:

• feat: — New features
• fix: — Bug fixes
• docs: — Documentation changes
• refactor: — Code changes that neither fix bugs nor add features
• test: — Adding or updating tests

Pull Requests

1. Create a feature branch from main
2. Make your changes with clear, atomic commits
3. Add tests for new functionality
4. Ensure all tests pass (bun run test)
5. Open a pull request with a clear description

Reporting Issues

Found a bug or have a feature request? Open an issue on GitHub.

License

By contributing to Fyren, you agree that your contributions will be licensed under the Elastic License 2.0 (ELv2) for core components and MIT for SDK components.