Contributing Guide

Technical documentation for developers and contributors.

Quick Start

git clone https://github.com/Relaticle/relaticle.git
cd relaticle && composer app-install
composer run dev

Visit http://localhost:8000 to access the application.

Tech Stack

Architecture

Core Models

Team ─┬─ User (via Membership)
      ├─ Company ─┬─ People
      │           └─ Opportunity ─── People
      ├─ Task (many-to-many with Company, People, Opportunity)
      └─ Note (many-to-many with Company, People, Opportunity)

Multi-Tenancy

All workspace data is isolated via the HasTeam trait. Every query automatically scopes to the current team.

Key Traits

Development Setup

Requirements

• PHP 8.5+ with extensions: pdo_pgsql, gd, bcmath, mbstring, xml
• PostgreSQL 17+
• Node.js 20+
• Composer 2+

Manual Installation

git clone https://github.com/Relaticle/relaticle.git
cd relaticle
composer install
npm install
cp .env.example .env
php artisan key:generate
php artisan migrate
php artisan storage:link
npm run build
composer run dev

Environment Config

For PostgreSQL:

DB_CONNECTION=pgsql
DB_HOST=127.0.0.1
DB_PORT=5432
DB_DATABASE=relaticle
DB_USERNAME=postgres
DB_PASSWORD=your_password

Quality Tools

composer lint          # Format with Pint + Rector
composer test:lint     # Check formatting
composer test:types    # PHPStan analysis
composer test:pest     # Run tests
composer test          # All checks (required before PR)

Git Hooks

Enable pre-commit checks:

git config core.hooksPath .githooks

Testing

All contributions require:

• Unit tests for new functionality
• Feature tests for user interactions
• Minimum 99.9% type coverage

Run specific tests:

php artisan test tests/Feature/ExampleTest.php
php artisan test --filter="test_method_name"

Custom Fields

Relaticle includes a custom fields system for extending entities without migrations.

• License: AGPL-3.0 (free for open source) or Commercial
• Docs: Custom Fields Documentation

Deployment

For production deployment instructions, including Docker setup, environment configuration, reverse proxy, and platform-specific guides (Dokploy, Coolify), see the Self-Hosting Guide.

Troubleshooting

Contributing

1. Fork the repository
2. Create a feature branch: git checkout -b feat/your-feature
3. Make changes following coding standards
4. Run tests: composer test
5. Commit with conventional messages
6. Open a Pull Request

PRs must pass all checks before merge.

Resources

• Laravel Docs
• Filament Docs
• Livewire Docs
• Pest Docs