Skip to content

AlexanderKopyl/boardly

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

541 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Boardly

Boardly is a Jira-like project/task/workflow management system.

Architecture Baseline

The project starts as a Symfony backend with:

  • Modular Monolith;
  • Hexagonal Architecture;
  • DDD;
  • CQRS where useful;
  • EDA where justified;
  • PostgreSQL as source of truth;
  • RabbitMQ for async side effects;
  • Redis for cache / fast storage;
  • OpenSearch for search / read-side use cases.

Read the architecture rules before designing modules or business flows:

docs/architecture/project-architecture-rules.md

AI agent entrypoint:

AGENTS.md

Requirements

Preferred local setup:

  • PHP 8.3+
  • Composer 2+
  • Docker
  • Docker Compose
  • Make

Symfony/PHP runs locally. Infrastructure runs in Docker.

First Install — Preferred Hybrid Mode

Copy local environment example:

cp .env.local.example .env.local

Install PHP dependencies locally:

composer install

Start infrastructure only:

make infra-up

Start Symfony locally:

make serve

Application:

http://127.0.0.1:8080

Health check:

GET http://127.0.0.1:8080/health

Expected response:

{"status":"ok"}

Alternative — Full Docker Mode

Use this only if local PHP/Composer/extensions are problematic:

make install
make up

Application:

http://localhost:8080

Infrastructure Services

RabbitMQ management UI:

http://localhost:15672

Default local credentials:

guest / guest

OpenSearch:

http://localhost:9200

PostgreSQL:

localhost:5432

Default local database credentials:

Database: boardly
User: boardly
Password: boardly

Redis:

localhost:6379

Useful Commands

Hybrid/local commands:

make infra-up       # Start PostgreSQL, Redis, RabbitMQ, OpenSearch
make infra-down     # Stop infrastructure services
make infra-restart  # Restart infrastructure services
make serve          # Run Symfony locally on 127.0.0.1:8080
make local-install  # Run composer install locally
make local-console  # Run Symfony console locally
make local-test     # Run PHPUnit locally
make local-phpstan  # Run PHPStan locally
make local-cs-fix   # Run PHP CS Fixer locally
make local-rector   # Run Rector locally
make local-qa       # Run local tests and static analysis

Full Docker commands:

make install  # Build app container and run composer install inside Docker
make up       # Start all services including app container
make down     # Stop all services
make restart  # Restart all services
make shell    # Open shell in app container
make console  # Run Symfony console inside Docker
make test     # Run PHPUnit inside Docker
make phpstan  # Run PHPStan inside Docker
make cs-fix   # Run PHP CS Fixer inside Docker
make rector   # Run Rector inside Docker
make qa       # Run tests and static analysis inside Docker
make logs     # Follow Docker logs

Composer Lock

This is an application repository, not a reusable library.

After the first successful install, commit:

composer.lock

This keeps dependency versions reproducible for all developers and CI.

Current Scope

This repository currently contains only the technical bootstrap:

  • Symfony kernel;
  • HTTP front controller;
  • console entrypoint;
  • health check endpoint;
  • Docker development stack;
  • PHPUnit/PHPStan/Rector/PHP CS Fixer configuration;
  • architecture documentation.

Business modules such as Issues, Projects, Workflow, Boards, and Permissions should be added only after the relevant architecture decision or module design is documented.

Documentation

  • AGENTS.md — AI agent entrypoint and documentation routing.
  • docs/architecture/project-architecture-rules.md — project architecture rules.
  • docs/agents/subagents-map.md — subagent routing map.
  • docs/adr/0000-template.md — ADR template.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors