Project 3 - Starter Kit - Symfony 4.3.1

Getting Started

Prerequisites

1. Check composer is installed
2. Check yarn & node are installed
3. Check php.intl is 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

Testing

1. Run ./bin/phpcs to launch PHP code sniffer
2. Run ./bin/phpstan analyse src --level 5 to launch PHPStan

Deployment

1. Edit your .env with your BDD's informations, MAILER_URL with your informations & password to send mail, MAILFROM informations to receive daily command mail and MAILTO to receive contact mail.

2. Run php bin/console doctrine:database:create to create database.

3. Run php bin/console doctrine:schema:update --force to create database's tables.

4. Run php bin/console doctrine:migrations:migrate to make necessary insert.

5. Run yarn encore production to build assets.

6. Run crontable -e to open cron file.

7. Edit cron file and add 0 2 * * * php /[path/to/the/project]/bin/console app:daily-mail to configure automatized mail, every day at 02:00am .

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 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