README.md

MeetDown

MeetDown is a MeetUp clone project for learning purposes. The focus is on advanced software development concepts like TDD, DDD, Hexagonal Architecture and CQRS.

Requirements

Production

• PHP 8.0
• Nginx 1.21
• MariaDB 10.6
• Elasticsearch 7.14

Development

• Docker
• Docker-Compose
• Free ports on host as defined in .env

Installation

1. Clone this repository:

   git clone [email protected]:thled/meetdown.git

2. Change to project directory:

   cd meetdown

3. Copy .env for Docker-Compose:

   cp .env.dist .env

4. Build and start the docker containers:

   docker-compose up -d

5. Initialize the app:

   docker-compose exec app composer bootstrap

Usage

• Access the application: http://localhost:80

• SSH into container:

  docker-compose exec app sh

• Manage DB with Adminer: http://localhost:8080

  • Start docker container:

    docker run --network meetdownnet -p 8080:8080 -e ADMINER_DESIGN='dracula' adminer

  • System: MySQL

  • Server: db

  • Username: db

  • Password: db

  • Database: db

Code Quality

To ensure a high quality of the code base different tools are used to analyse, lint and fix code which does not adhere to the standards (PSR, Symfony etc.).

• PHP-CS-Fixer (lint):

  rl

• PHP-CS-Fixer (fix):

  rf

• Deptrac/Psalm/PHPStan:

  ra

• Continues Integration:

  rc

Developing

Tests

Usage

• Run whole test suite:

  rt

• Run test watcher:

  rw

Contribute

Please do contribute! Issues and pull requests are welcome.