Skip to content

Commit

Permalink
docs(global_project_doc)
Browse files Browse the repository at this point in the history
  • Loading branch information
AliciaMV committed May 25, 2022
1 parent cf88e95 commit fb5dec5
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/global_project_doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,13 @@ This method handles the sending of an email to a user's mailbox and the creation
The method is linked to the `ressources` folder which contains the markdown blade file and the custom components and CSS files.


## Middleware
### Authenticate middleware
This middleware is not used anymore as we now pass by the `jwt.auth` middleware providied by the Tymon\jwt-auth package.

### EnsureEmailsVerified middleware a.k.a Verified
This middleware check if the user has a verified email in the DB or is currently verifying his email address before to grant access to all the routes it protects. It uses the MustVerifyEmail traits to check the DB.


## Models organization
The models contains mostly the table relationships and the default fields data. Some also use or implements specific packages or traits to allow the JWT authentification, email address verification and mail/notification send. The User model also contains method to retrieve a user using only JWT, the notification "route" to send it and an unused boot method to handle email address update in one user profile, firing a new verification email.
Expand All @@ -60,7 +67,5 @@ If a file or provider is missing there, the app won't load it and therefore won'


## Database folder
The DB folder contains all migration related folders. Which means the migrations themselves and the dummies data. Those process are described in the *DB_migration_doc.md*.


The DB folder contains all migration related folders. Which means the migrations themselves and the dummies data (factories and seeders files). Those process are described in the *DB_migration_doc.md*.

0 comments on commit fb5dec5

Please sign in to comment.