Home

Welcome to the symfony-beelab wiki!

This project is meant to create a new Symfony project, using a predefined Docker configuration.

Setup

• execute composer create-project beelab/symfony-beelab yourDir (where "yourDir" is the path of the directory where you want to create the project). Alternatively, if can clone this project and then remove .git directory. If you want to use a specific branch, use the following example: git clone git@github.com:Bee-Lab/symfony-beelab.git --branch garak --single-branch yourDir. Cloning is more feasible if you only use Docker (e.g. you don't have PHP installed on your host machine)
• replace the content of README.md with your instructions for the project. This is important since anyone should be able to be up&running on your project in (almost) zero time!
• feel free to remove LICENSE, or to replace it with your license
• replace the content of composer.json and package.json with your actual project name, description, authors, etc.
• replace "customize" with your project's name in relevant files. You can use the following script in the terminal (assuming your project is named "myproject"): find . -type f -exec sed -i 's/customize/myproject/g' {} \;
• build the project using docker-compose build
• start the project using make start. You need the make utility. If you don't have it, check the Makefile file and use relevant commands instead.
• if you didn't create the project with composer, execute docker-compose exec php composer install
• execute make npm and then make asset (this last can be stopped, if successful)
• after adding some entities, execute make dbupdate
• you can execute tests with make test (a simple predefined test is available}