README.md

EXAMPLE HEXAGONAL PROJECT

This app is a API Symfony app containing:

• a database models & connection PostgreSQL + doctrine
• a GraphQL API for the React front client.

-> Hexagonal documentation <-

Requirements

• Symfony CLI
• Docker

Setup

• If you already have Symfony CLI locally, you're done!

List all commands for Makefile (& URLs)

make

Installation

make install

Install database

Tip

Working with ULIDs & Database

Working with Fixtures

make db.install
make db.fixtures

Linting

make lint

Tests

Tip

How to do debug & test

make test

Run the app

Warning

Don't forget to make install before and init db + fixtures.

Serve symfony

make serve

Stop symfony

make stop

Going further

• How to authenticate as a User for GraphiQL console
• Tests & debug
• Fixtures & stories
• Working with ULIDs
• GraphiQL: how to trigger queries and mutations
• Usecase: how to trigger the forgot password

Urls

• GraphiQL (QraphQL Web console)
• Mailer
• Symfony profiler

Useful tools

• PhpStorm GraphQL Extension: provides GraphQL support in PhpStorm as well as syntax highlight, schema discovery and autocompletion.
• PhpStorm UUID/ULID Generator Extension: provides UUID/ULID generation in PhpStorm.

---