Project 3 - Starter Kit - Symfony

Presentation

This starter kit is here to easily start a repository for Wild Code School students.

It's symfony website-skeleton project with some additional library (webpack, fixtures) and tools to validate code standards.

• GrumPHP, as pre-commit hook, will run 2 tools when git commit is run :

  • PHP_CodeSniffer to check PSR12
  • PHPStan focuses on finding errors in your code (without actually running it)
  • PHPmd will check if you follow PHP best practices

  If tests fail, the commit is canceled and a warning message is displayed to developper.

• Github Action as Continuous Integration will be run when a branch with active pull request is updated on github. It will run :

  • Tasks to check if vendor, .idea, env.local are not versionned,
  • PHP_CodeSniffer, PHPStan and PHPmd with same configuration as GrumPHP.

Getting Started for Students

Prerequisites

1. Check composer is installed
2. Check yarn & node are installed

Install

0. PHP 8.1.xx minimum required -> sudo update-alternatives --set php /usr/bin/php8.1 -> sudo update-alternatives --config php choose version and validate -> php -v to verify.
1. Need to set email DSN
2. Clone this project
3. Run yarn setup
4. Create your env.local file from .env depending on the database you would like to use
5. Run yarn migration to build assets

Working

1. Run symfony server:start to launch your local php web server
2. Run yarn run dev --watch to launch your local server for assets (or yarn dev-server do the same with Hot Module Reload activated)

Testing

1. Run php ./vendor/bin/phpcs to launch PHP code sniffer
2. Run php ./vendor/bin/phpstan analyse src --level max to launch PHPStan
3. Run php ./vendor/bin/phpmd src text phpmd.xml to launch PHP Mess Detector
4. Run ./node_modules/.bin/eslint assets/js to launch ESLint JS linter

Windows Users

If you develop on Windows, you should edit you git configuration to change your end of line rules with this command:

git config --global core.autocrlf true

The .editorconfig file in root directory do this for you. You probably need EditorConfig extension if your IDE is VSCode.

Run locally with Docker

1. Fill DATABASE_URL variable in .env.local file with DATABASE_URL="mysql://root:password@database:3306/<choose_a_db_name>"
2. Install Docker Desktop an run the command:

docker-compose up -d

3. Wait a moment and visit http://localhost:8000

Deployment

Some files are used to manage automatic deployments (using tools as Caprover, Docker and Github Action). Please do not modify them.

• captain-definition Caprover entry point
• Dockerfile Web app configuration for Docker container
• docker-entry.sh shell instruction to execute when docker image is built
• nginx.conf Nginx server configuration
• php.ini Php configuration

Built With

• Symfony
• GrumPHP
• PHP_CodeSniffer
• PHPStan
• PHPMD
• ESLint
• Sass-Lint

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

Authors

• Hugues Hertout - https://github.com/hhertout
• Cédric Le Valégant - https://github.com/cedriclv
• William Bouet - https://github.com/williambouet
• Hugo Houdas - https://github.com/HuHoudas

License

MIT License

Copyright (c) 2019 [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Acknowledgments