Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
Bee-color framework
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Operations
Operations
Incidents
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Jordan Breton
Bee-color framework
Commits
22d1b140
Commit
22d1b140
authored
Aug 10, 2019
by
Jordan Breton
✏
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Removing fr README and added important message about documentation
parent
97683711
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
4 additions
and
72 deletions
+4
-72
README.en.md
README.en.md
+4
-1
README.md
README.md
+0
-71
No files found.
README.en.md
View file @
22d1b140
Ce document est également disponible en
[
français
](
README.md
)
# Documentation update
**
Since a major update is about to be released, the current documentation website is outdated and will
be entierly rewritten to be clearer and takes new functionnalities into consideration.
**
# Foreword
...
...
README.md
deleted
100644 → 0
View file @
97683711
This document is also available in
[
english
](
README.en.md
)
.
# Avant-propos
Le framework
**wfw**
(pour Web FrameWork) est un framework prévu pour la réalisation
de sites web et/ou services et/ou application plus ou moins complexes et est
déjà équipé d'un système de gestion des langues et a été écrit en
**PHP 7.2**
.
Le but est de promouvoir un support de base pour la création de projets articulés autour
du principe
**CQRS**
et pour offrir un support de base à l'
**Event-sourcing**
. Si vous souhaitez
vous documenter sur ces sujets, n'hésitez pas à visionner les conférences de
**Greg Young**
et
de ses confrères.
Son architecture ne se base pas sur MVC (ou aucun autre de ses dérivés) parce
que ce pattern est avant tout destiné à des long-running process et qu'il est bien
souvent utilisé à tort et à travers, et souvent mal appliqué (je vous renvoie
sur les articles éclairés et documentés de Tom Butler sur ce design
pattern, et notamment les deux articles très justement appelés
[
MVC : Model-View-Confusion
](
https://r.je/views-are-not-templates.html
)
).
Un serveur http ayant un fonctionnement totalement différent, j'ai choisi d'implémenter
un pattern personnalisé à base de handlers, prévu pour simplifier au maximum
la création de sites internet sans impacter le nombre de possibilités d'utilisation.
De plus, j'ai choisi volontairement de limiter au strict minimum le recours à
des librairies tierces afin de garder la maîtrise de l'évolution du framework
sans avoir à dépendre d'autres projets, afin de pérenniser mon travail.
La réutilisation du code est une très bonne chose, lorsqu'elle est faite avec
intelligence et discernement. Un projet qui a besoin de plus de 10 autres projets
indépendants devient très difficile à maintenir avec le temps.
## Attribution :
Si l'un des principaux buts de ce framework est de limiter le recours aux dépendances
à d'autres projets, j'en ai tout de même intégré trois au coeur du framework :
-
[
PHPMailer
](
https://github.com/PHPMailer/PHPMailer
)
-
[
HTMLPurifier
](
http://htmlpurifier.org/
)
-
[
Dice
](
https://github.com/Level-2/Dice
)
Pourquoi ? Parce que ces librairies me semblent parfaitement indispensables et
surtout sont bien plus abouties que tout ce que j'aurais pu coder moi même:
-
**HTMLPurifier**
est un projet brillant qui demande des connaissances que je ne
possède pas dans le domaine des failles XSS.
-
**PHPMailer**
, qu'il est inutile de présenter, est une fantastique librairie pour
les envois de mails.
-
**Dice**
est le seul conteneur d'injection de dépendances qui joue son rôle avec
efficacité sans dévier de son objectif principal. Ses performances rivalisent avec
les DIC les plus aboutis (et les surpassent même, voir les tests de performance
[
ici
](
https://github.com/Level-2/Dice#performance
)
).
Il est par ailleurs à noter que ces librairies sont intégrées au coeur du framework,
mais peuvent être remplacées si vous le souhaitez par celles de votre choix.
WFW se veut totalement souple, et j'espère que ce pari est réussi.
# Documentation
La documentation complète est disponible sur un
[
site internet dédié
](
https://wfwdoc.bee-color.fr
)
.
# Contribution
N'hésitez pas à contribuer !
Je fais actuellement de mon mieux pour essayer de proposer
la documentation en deux langues : anglais et français. Si vous avez des corrections
à apporter, ou des traductions à proposer, je les accepte volontiers.
Enfin, je fais tout mon possible pour produire une documentation aussi claire et
détaillée que possible, mais je ne suis pas à l'abri d'erreurs, notamment dans
la documentation en anglais. Plus que votre indulgence, votre participation sera
grandement appréciée.
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment