[Circus][https://dhil.lib.sfu.ca/circus] is a PHP application written using the [Symfony Framework][https://symfony.com]. It is a digital tool for collecting newspaper clippings about circus performances in England.
- Docker Desktop
- A copy of the
circus.sqldatabase sql file. If you are not sure what these are or where to get them, you should contact the Digital Humanities Innovation Lab for access. This file should be placed in the root folder.
First you must setup the database for the first time
docker compose up -d db
# wait 30 after the command has fully completed
docker exec -it circus_db bash -c "mysql -u circus -ppassword circus < /circus.sql"
Next you must start the whole application
docker compose up -d --build
circus will now be available at http://localhost:8080/
docker exec -it circus_app ./bin/console nines:user:create <[email protected]> '<your full name>' '<affiliation>'
docker exec -it circus_app ./bin/console nines:user:password <[email protected]> <password>
docker exec -it circus_app ./bin/console nines:user:promote <[email protected]> ROLE_ADMIN
docker exec -it circus_app ./bin/console nines:user:activate <[email protected]>
example:
docker exec -it circus_app ./bin/console nines:user:create [email protected] 'Test User' 'DHIL'
docker exec -it circus_app ./bin/console nines:user:password [email protected] test_password
docker exec -it circus_app ./bin/console nines:user:promote [email protected] ROLE_ADMIN
docker exec -it circus_app ./bin/console nines:user:activate [email protected]
docker compose up -d
docker compose down
docker compose up -d --build
docker logs -f circus_app
docker logs -f circus_db
docker logs -f circus_mail
http://localhost:8080/
Command line:
docker exec -it circus_db mysql -u circus -ppassword circus
Through a database management tool:
- Host:
127.0.0.1 - Port:
13306 - Username:
circus - Password:
password
http://localhost:8025/
Migrate up to latest
docker exec -it circus_app make migrate
First setup an image to build the yarn deps in
docker build -t circus_yarn_helper --target circus-prod-assets .
Then run the following as needed
# add new package
docker run -it --rm -v $(pwd)/public:/app circus_yarn_helper yarn add [package]
# update a package
docker run -it --rm -v $(pwd)/public:/app circus_yarn_helper yarn upgrade [package]
# update all packages
docker run -it --rm -v $(pwd)/public:/app circus_yarn_helper yarn upgrade
Note: If you are having problems starting/building the application due to javascript dependencies issues you can also run a standalone node container to help resolve them
docker run -it --rm -v $(pwd)/public:/app -w /app node:19.5 bash
[check Dockerfile for the 'apt-get update' code piece of circus-prod-assets]
yarn ...
After you update a dependency make sure to rebuild the images
docker compose down
docker compose up -d
# add new package
docker exec -it circus_app composer require [vendor/package]
# add new dev package
docker exec -it circus_app composer require --dev [vendor/package]
# update a package
docker exec -it circus_app composer update [vendor/package]
# update all packages
docker exec -it circus_app composer update
Note: If you are having problems starting/building the application due to php dependencies issues you can also run a standalone php container to help resolve them
docker run -it -v $(pwd):/var/www/html -w /var/www/html dhilsfu/symfony-base:php-8.2-apache bash
[check Dockerfile for the 'apt-get update' code piece of circus]
composer ...
After you update a dependency make sure to rebuild the images
docker compose down
docker compose up -d
First make sure the application and database are started with docker compose up -d
docker exec -it circus_app make test
docker exec -it circus_app make test.cover
make test.cover.view
If the coverage file doesn't open automatically you can manually open it coverage/index.html
See standards errors
docker exec -it circus_app make lint-all
docker exec -it circus_app make symlint
# or
docker exec -it circus_app make stan
docker exec -it circus_app make twiglint
docker exec -it circus_app make twigcs
docker exec -it circus_app make yamllint
docker exec -it circus_app make symlint
Automatically fix some standards errors
docker exec -it circus_app make fix.all
docker exec -it circus_app make dump.autowire
docker exec -it circus_app make dump.container
docker exec -it circus_app make dump.env
docker exec -it circus_app make dump.params
docker exec -it circus_app make dump.router
docker exec -it circus_app make dump.twig