Getting Started for Developers

Coach Moi is a site that connects coaches with people who want to practice a sport (or an activity)! The purpose of the site is to connect people with coaches that best meet client levels, which it is beginner, intermediate or confirmed. Thanks to the site a place of appointment can be fixed in a precise place, such as a room or an outdoor training space. In short, Coach Moi is there to facilitate the search for an activity while offering a wide choice of activities.

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

Database

1. Copy .env and rename it to .env.local. Configure it with your personnal information.
2. Create the database by running symfony console doctrine:database:create
3. Run symfony console doctrine:migration:migrate
4. Load the fixtures with symfony console doctrine:fixtures:load

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 .vendor/bin/phpcs to launch PHP code sniffer
2. Run .vendor/bin/phpstan analyse src --level max to launch PHPStan
3. Run .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
5. 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

To deploy on Cap Rover, follow instructions in the manual and add, at least, two "Environmental Variables" in "App Configs" tab:

• APP_ENV with prod/dev value
• DATABASE_URL with the connection informations given by caprover when you create the related DB app.

Caprover configuration files are :

• captain-definition Caprover entry point
• Dockerfile Web app configuration for Docker container
• docker-compose.yml ...not use it's used 😅
• 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

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

Thank you to Thuy Dieu, Khadim Bousso, Serdar Vural, Loic Pinguet and Emma Guesbaya. The best team!

Login details (with fixtures)

• [Superadmin]

1. Email: [email protected]
2. Password: coachmoi

• [Coach]

1. Email: [email protected]
2. Password: admincoachmoi

• [Client]

1. Email: [email protected]
2. Password: usercoachmoi