Project 3 - Starter Kit - Symfony 4.2.8

This starter kit is here to easily start a repositry for your students.

It's symfony website-skeleton project with some additionnal tools to validate code standards.

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

  • PHP_CodeSniffer to check PSR2
  • PHPStan will check PHP recomendation

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

• Travis CI, as Continuated 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 to check PSR2,
  • PHPStan will check PHP recomendation.

Getting Started for Projects

Prerequisites

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

Install

1. Clone this project
2. Run composer install
3. Run yarn install

Working

1. Run php bin/console server:run to launch your local php web server
2. Run yarn run dev --watch to launch your local server for assets

Deployment

Add additional notes about how to deploy this on a live system

Built With

• Symfony
• GrumPHP
• PHP_CodeSniffer
• PHPStan
• Travis CI

Contributing

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

Versioning

Authors

Wild Code School trainers team

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