edwigegc / todo

ToDoList is an application to manage daily tasks. Developped first with Symfony 3.1. My work was to reduce technical debt and install tests with phpunit

ToDo

This project was made to validate my training as a web PHP/Symfony developer. The fake company ToDo & Co developed its first application with Symphony framework 3.1 a few years ago and didn’t maintain it. This application allows registered and logged-in users to manage the to-do list of their team.
My job was to improve it.

Getting start

Prerequisites

Installation of To Do List requires:

• Symfony 4.4
• PHP version 7.4.12
• MySQL version 5.7
• Apache Server 2.4.46
• Composer 2.0
• Doctrine/ORM < 2.5
• Bootstrap 5.0

Dependency used for testing the project:

• phpunit/phpunit < 9.5

Installation

1. On your local machine, create a local repository and make a
   git remote add to your GitHub repository
2. Copy the link on GitHub and clone it on your local repository
   git clone https://github.com/EdwigeGC/ToDo.git
3. Open your terminal and run: composer install to install dependencies
4. Open file .env and configure username and password for database connection. Example:
   DATABASE_URL="mysql://db_user:[email protected]:3306/db_name?serverVersion=5.7
5. Create database:
   php bin/console doctrine:database:create
doctrine:schema:create
6. Fill the database with fixtures:
   php bin/console make:migration
php bin/console doctrine:migration:migrate
php bin/console doctrine:fixtures:load

Features

Only registered users can access to the application:

• Get list of all tasks to do
• Get list of all tasks done
• Get the details of a task
• Edit a task
• Mark a task as done
• Delete a task (if the user is the author of the task)
• Authenticate

The admin can also:

• Create a user
• Edit a user
• Manage unassigned tasks

Run the tests: In your terminal, run vendor/bin/phpunit

Credit

photos: @SaroOh

Contribution

If you want to contribute to this project and make it better, your help is very welcome. Look the documentation to see how contribute.

todo's Issues

As a user, I want to be the only one to delete the tasks I had created

Audit documentation

Create a service to manage password with email

When a user is created, he receive an email to confirm his registration and can choose a password.
When a user forgot his password or need to change it, the admin can send a link on user email box to renew it.

Estimated time: 6h

As an admin user, I want to manage anonymous tasks

Technical documentation: authentication management

Enrich tasks options

Add atributes as an ending date, a priority order, theme.
Users can also add attached files or pictures to task.

Estimated time: 4 hours

Paginate

Set up a pagination service for users list and tasks list.
Set up filter to choose a criteria as date, user, priority order

Estimated time: 4h

Tests set up

Contribution document for other developers

First analyses

• migrate Symfony to newer version
• blackfire analyse

Each user must have a role assigned

When a user is created, a role is choosen. differnet kind of role:
ROLE_ADMIN and ROLE_USER
The role can be changed

As an admin user, I want to be the only one to manage users

Set up cache to improve the loading speed of a page

Cache to set up on tasks list, users list, homepage

Estimated time: 2h

Update Bootstrap from 3.3 to latest current version (4.6)

Estimated time: 2h

Tasks must be assigned to a user

When a task is created, it is assigned to the authenticated user and this one can't be changed.
Tasks without user must be linked to an anonymous user.

Document the code

Set up a documentation as phpDocumentor to make the code easier to read.

Estimated time: 2h

Set up a continuous integration tool

Project installation

copy original project

Correct last depreciations

The goal is to maintain the code and eventually be able to migrate to the new version of Symfony: 5.2

Estimated time: 4h