OpenClassrooms - Training Course DA PHP/Symfony - Project P08 - Upgrade an existing Symfony project
My WebSite is Online and you can visit it : APi - Site CV
- This file explains how to install and run the project.
- IDE used : PhpStorm.
- I use a Docker Stack as personal local development environment, but you can use your own environment.
- Both method to install the project are the described bellow.
- Want to contribute to this project ? Please read the Contributing Guidelines before (ongoing redaction...).
Realized by Adrien PIERRARD - (see GitHub)
Supported by Antoine De Conto - OCR Mentor
Special thanks to Rui TEIXEIRA and Yann LUCAS for PR Reviews
What you need :
- Symfony 4.4.*
- PHP 7.2
- MySQL 8 - (I use PHPMyAdmin)
- Demo data provided through fixtures to load with Doctrine after DB creation
Follow each following steps :
- First clone this repository from your terminal in your preferred project directory.
https://github.com/WizBhoo/OCR_P08_ToDoList.git- You need to edit the ".env" file to add your credentials for Doctrine DB connection and Mailer system chosen.
- I recommend you to copy the ".env" file and setup your credentials in a ".env.local" file.
- Launch your local environment.
- From your terminal, go to the project directory and tape those command line :
composer install
php bin/console doctrine:database:create
php bin/console doctrine:migrations:migrate
php bin/console doctrine:fixtures:load- Well done ! Project installed ! So you just have to go to your localhost home page.
- My Docker stack provide a development environment ready to run a Symfony project.
- Follow this link and read the README file to install it : Docker Symfony
- Prerequisite : to have Docker and Docker-Compose installed on your machine - Docker Install
- Preferred Operating System to use it : Linux / Mac OSx
Once you have well installed my Docker Stack, follow each following steps :
- From your terminal go to the symfony directory created by Docker.
- Clone this repository inside.
https://github.com/WizBhoo/OCR_P08_ToDoList.git- You need to edit the ".env" file to add your credentials for Doctrine DB connection and Mailer system chosen.
- I recommend you to copy the ".env" file and setup your credentials in a ".env.local" file.
- From your terminal go to the Docker directory and launch Docker using those command lines :
make build
make start or make upYou can also use "make help" to see what "make" command are available.
- You can access to PHPMyAdmin using pma.localhost but as already mentioned, you will create the DB and load data fixtures through command lines with Doctrine (See next steps).
- From your terminal, always in the Docker directory, tape those command lines :
make sh
cd symfony/
composer install
php bin/console doctrine:database:create
php bin/console doctrine:migrations:migrate
php bin/console doctrine:fixtures:load- Well done ! Project installed ! So you just have to go to mon-site.localhost home page.
- This project takes part of my training course to become a developer. Data presented are only used for demonstration.
- Initially, base project provided was developed under Symfony 3.1 and didn't work on a voluntary basis.
- The goal was to test it and to refactor it in order to upgrade it.
- Bugs have been identified and fixed, some new features have been implemented following ToDo & Co expectations.
- A Quality code & App performance Audit has been conducted to establish the App technical debt inventory and define an improvement plan.
- Some issues have been created from this plan, and you can contribute by working on it.
- You can also suggest your own improvement issue to do and/or open an issue if you identify a bug.
- What ever the way you wish to contribute, please read the Contributing Guidelines before (ongoing redaction...).
Thanks in advance for Star contribution
Any question / trouble ?
Please send me an e-mail ;-)