This is an experimental project aimed at exploring Symfony, Nginx, PHP 8.1, and some additional vendors for providing API documentation.
- Docker
Follow the steps below to set up the project locally:
-
Clone the repository:
git clone <repository-url>
-
Build and run the Docker containers:
docker-compose build
docker-compose up -d
- This command will build the necessary Docker images and start the containers for PHP, Nginx, and MariaDB.
-
Access the application:
- Open your browser and go to
http://localhost:8080
. - You should see the application running.
- Open your browser and go to
$ make test
Provide a brief description of the project structure and important files/directories here.
Explain the purpose of the API documentation and mention the vendors or tools used for generating it.
This utility command can be used to print file contents for exploration:
$ find . -type f -exec printf '### START OF FILE ###\n%s\n' {} \; -exec cat {} \; -exec printf '### END OF FILE ###\n' \;
$ docker-compose -f docker-compose-test.yml build
$ docker-compose -f docker-compose-test.yml up -d
$ docker-compose -f docker-compose-test.yml exec app-test bash
# php bin/console --env=test doctrine:schema:create
# ./bin/phpunit tests/Integration
# XDEBUG_MODE=coverage ./bin/phpunit --coverage-html coverage
Remove test environment
$ docker-compose -f docker-compose-test.yml down