https://github.com/wildcodeschool/reims-202109-php-project3-marche-conclu
https://github.com/wildcodeschool/reims-202109-php-project3-marche-conclu
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/wildcodeschool/reims-202109-php-project3-marche-conclu
- Owner: WildCodeSchool
- Created: 2021-12-07T16:43:58.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-04T08:30:16.000Z (over 4 years ago)
- Last Synced: 2025-06-07T05:11:30.301Z (about 1 year ago)
- Language: PHP
- Size: 75.2 MB
- Stars: 2
- Watchers: 8
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Project 3 - Starter Kit - Symfony 5.*
## 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
1. Clone this project
2. Run `composer install`
3. Run `yarn install`
4. Run `yarn encore dev` 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
### 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
3. Run `./node_modules/.bin/eslint assets/js` to launch ESLint JS linter
3. Run `./node_modules/.bin/sass-lint -c sass-linter.yml -v` to launch Sass-lint SASS/CSS 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`
## Deployment
Some files are used to manage automatic deployments (using tools as Caprover, Docker and Github Action). Please do not modify them.
* [captain-definition](https://github.com/WildCodeSchool/sf4-pjt3-starter-kit/blob/master/captain-definition) Caprover entry point
* [Dockerfile](https://github.com/WildCodeSchool/sf4-pjt3-starter-kit/blob/master/Dockerfile) Web app configuration for Docker container
* [docker-compose.yml](https://github.com/WildCodeSchool/sf4-pjt3-starter-kit/blob/master/docker-compose.yml) ...not use it's used 😅
* [docker-entry.sh](https://github.com/WildCodeSchool/sf4-pjt3-starter-kit/blob/master/docker-entry.sh) shell instruction to execute when docker image is built
* [nginx.conf](https://github.com/WildCodeSchool/sf4-pjt3-starter-kit/blob/master/nginx.conf) Nginx server configuration
* [php.ini](https://github.com/WildCodeSchool/sf4-pjt3-starter-kit/blob/master/php.ini) Php configuration
## Built With
* [Symfony](https://github.com/symfony/symfony)
* [GrumPHP](https://github.com/phpro/grumphp)
* [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer)
* [PHPStan](https://github.com/phpstan/phpstan)
* [PHPMD](http://phpmd.org)
* [ESLint](https://eslint.org/)
* [Sass-Lint](https://github.com/sasstools/sass-lint)
## Contributing
Please read [CONTRIBUTING.md](https://gist.github.com/PurpleBooth/b24679402957c63ec426) 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 aurelien@wildcodeschool.fr
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