Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/annaigjegourel/oc-p8-todo
Improving the MVP of a start-up (study project): upgrade & fix code, implement authorizations & automated tests
https://github.com/annaigjegourel/oc-p8-todo
php phpunit symfony symfony-application
Last synced: 6 days ago
JSON representation
Improving the MVP of a start-up (study project): upgrade & fix code, implement authorizations & automated tests
- Host: GitHub
- URL: https://github.com/annaigjegourel/oc-p8-todo
- Owner: AnnaigJegourel
- License: mit
- Created: 2023-05-11T12:47:32.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-25T11:03:23.000Z (about 1 year ago)
- Last Synced: 2023-10-25T12:49:59.665Z (about 1 year ago)
- Topics: php, phpunit, symfony, symfony-application
- Language: HTML
- Homepage:
- Size: 4.38 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# OC-P8-Todo
Training program "Back-end Developer: PHP/Symfony" (OpenClassrooms)
Project 8: Upgrade an existing project (study project)
- Improving the MVP of a start-up: upgrade & fix code, implement authorizations & automated tests
- The mission:
- The MVP:
✅ Validated on June 14, 2023
[](https://app.codacy.com/gh/AnnaigJegourel/OC-P8-Todo/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://codeclimate.com/github/AnnaigJegourel/OC-P8-Todo/maintainability)
## Configuration / Technologies ⚙️
xamppserver
MySQL / MariaDB
PHP 8.1
Symfony 5.4
## Installation 🧑🏻🔧
### Importing the repository
1. Clone the repository to work on your localhost.
2. To install the dependencies, run the following command at the root of the project:
````text
composer intall
````
### Configuring the database
3. Launch xamppserver, configure your php version.
4. Create the database running:
````text
php bin/console doctrine:database:create
````
5. Import its structure using this command:
````text
php bin/console doctrine:schema:update --force
````
6. You can also load the fixtures as initial set of data:
````text
php bin/console doctrine:fixtures:load
````
### Launching the project
7. Launch the Symfony server running:
````text
symfony server:start
````
🎉 Congrats! You can now watch at the project in your navigator following the link given in your terminal, mostly:
## Working on tests 🧑🏽🔬
### Set up the environment
1. Once your project is installed as described above, you should have PHPUnit, phpunit-bridge (in the project, running composer) & x-debug (in Xampp) ready.
2. Configure your .env.test file to access the test data in your database.
3. Create the test database & its tables running:
````text
php bin/console doctrine:database:create
````
````text
php bin/console doctrine:schema:update --force
````
4. Then load the test fixtures:
````text
php bin/console doctrine:fixtures:load
````
### Review the existing tests
- their classes & methods in the repository /tests/
- their results in /public/test-coverage/
- read it easily in a navigator:
### Create and modify tests
- Write your code in tests/
- To execute all tests, run the following command:
````text
php vendor/bin/phpunit
````
- Generate the test coverage report running:
````text
php vendor/bin/phpunit --coverage-html public/test-coverage
````