[FEATURE] Adding some explanation on the project

JustalK · Nov 6, 2020 · b2cf088 · b2cf088
1 parent 2adcc1d
commit b2cf088
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 3 deletions.
diff --git a/documentation/management/cycle.jpg b/documentation/management/cycle.jpg
diff --git a/documentation/management/src/database.jpg → documentation/management/database.jpg b/documentation/management/src/database.jpg → documentation/management/database.jpg
diff --git a/documentation/management/flowchart.jpg b/documentation/management/flowchart.jpg
diff --git a/documentation/management/src/cycle b/documentation/management/src/cycle
@@ -0,0 +1 @@
+<mxfile userAgent="Mozilla/5.0 (Windows NT 6.1; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/66.0.3359.139 Safari/537.36" version="8.6.2" editor="www.draw.io" type="device"><diagram id="07fea595-8f29-1299-0266-81d95cde20df" name="Page-1">7ZrZcqM4FIafxpdNaQEBlzF22qnqtFP2TE/NpWIrWNUyookSO/P0czDCLLaTnpqQkIUbw68FLd/5kcADGq23XzOeri71UqgBQcvtgI4GhBBEffjJlYdC+YLdICikOJPLQsSVMJf/CCsiq97JpbhtZDRaKyPTprjQSSIWpqHxLNObZrYbrZp3TXksDoT5gqtD9S+5NCurYhZWCRMh45W9dUBsl6/54mec6bvE3m9A6M3uKJLXvKzLdvR2xZd6U5PoeECjTGtTnK23kVD56JbDVpQ7P5G6b3cmEvM7BZjrFkXuuboTZZuZgsLDGw11QBPNgx0W9utOlwlfbneTdgYZKEq3VeJuVpTOGiVqw1BJLLa/u7tdt4XblCeldj6dQm0ompxdfC/ToVP1LPt6sscqiv6Ovo2fqAHkg8aAVgzH6ZuRxlgRmNk0P12JLY91AllSkcm1MCKr1KtSgokfblbSiHnKF3mxDYQWaCuzVnCF826UqCC4UPxaqOEetsiOeKITkWc1mf4pov00UEJd1xvlUyeVOqbHGV9KYKZVUd7nc76WKo/kiVD3wsgFtwk2bAm11+16AbEhVzKGvo8WUHfecdu0MqjofuTuRWbE9iTFeB8b4DpCw5hlD5DFFnBJ4Hh+ELo+ZYELceoVNVj/IT5zHT8MiOsx7CJaMr+pQpti7OQlkUcYxVAXK7KsakFOvNAJWC2XzcOt2cT7dlUBByc25k7Fn3ck/loomUzyJM6vOmOknO8mHue74zc5wP5/4SDThhuZx8UoRI8AqGT6w3YuP5/Ycw1DIE3eGoKehyGKQqeNTUAcVju8A2x8cogJ9shzcMH+ty8T2vRl64DfLi7P/hifNLa3aGP22dKNjY16Y2Mecp/g8fVszO8I16vZdPRnNJ7N3xWwe2N9289dxsAga8SSJq+Mug4Ow+Kh66ESxl7wGnTE6/Ty+8WP6ex9+evHwBV0hzAvJ9X3cUiCHuEadoTrZDwbfvLaU16fWA9QRHq7rfFQV8vXs9mnwfYVWAwO2lqz9thUPfw8jO7gbGE6GkfTy6vp/L0tXN/JTmsHKqoO/GYWruXLhV6+L6qo6fJ9EcWn+euEFh+hFh8seGoj7h3y4NPnmH/6Of+PzH/9HWE3azLafsRR5DZfy7wgDMc+3nwwGEj4wm7gsoNFDkTlq/lBn78f9ACBzg2BMf/AEODB/0qGcOyrwcei4bGvSZ0AECDsoNouvbX/8WEp+UrWcOyd/CcML+YMlBInrG0RQtZCw0UvgwZcVv8o2aXV/rhDx/8C</diagram></mxfile>
diff --git a/documentation/management/src/flowchart b/documentation/management/src/flowchart
@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2020-11-06T02:43:05.517Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.183 Safari/537.36" etag="cly5DeImQU4xQN5fIeJw" version="13.9.2" type="device"><diagram id="C5RBs43oDa-KdzZeNtuy" name="Page-1">5VrZdps6FP0aPyaLwWD8WLsZOq606b1Jn+6SQWBdC+QKeerXVxgJEGAgjocmyUMW5/hY09lna0u4Z47D9Q0F8+kX4kHcMzRv3TPf9wzDsR3+P3FsUke/308dAUVe6tJzxz36DYVTE94F8mCsBDJCMENz1emSKIIuU3yAUrJSw3yC1V7nIIAVx70LcNX7gDw2FdMyBrn/FqJgKnvW7WH6SQhksJhJPAUeWRVc5lXPHFNCWPoUrscQJ2sn1+Xhw+YBf57ZNx+/xb/AP6NPP77+e5E2dv2Ur2RToDBih23aSJteArwQ6yXmyjZyASlZRB5MGtF65mjKQswfdf74P2RsIxIOFoxwF6FsSgISAfyZkLmI80nERJie2DDy3iWJ5fYEE3eWuq4RxqIPbol4h1sxo2SW5S5pIEtEEozBBOIRcGfBdqBjggnlH0UkgklTHgeDmEs+uKvcO+q4tiIHMVlQFzbEmQLigAawqT07jUvGV8CpyNwNJCFkdMMDKMSAoaUKZiBqIsji8rzzB5H6J8DArMDglrfMPXdJde1GRJKN1RQxeD8H22VZcQ5RUVLMPp/gKMAgjkXuWlLrc0jIfPYM03dc6LrZ1wqfTByrb2lPTuYSUgbXjcsvPxUUIDhQHwp7lTOKLmliWmCTvnakhPUrCbvj8ObkiMhbK2Cearp5TBq7tKT5MxsIN96vFWsjrAMXvl0t/AkezW4fP1Kbkd9OtPzv5sNXJEuttfAF8i60S22oDRX4XUhYdSYH0fwdQXyueQjx/ZgPVtk1ZIzoP9v9RN/GsATpdMLiWyVUZ9PZH+hWBejfYbwIq6TUDpQXXQfHQWsrCiXhnQ5wllMCnH40wNXWZ1URfUkW4ioECD8bdLWwqoFfAZxwjdhj4fln4TlntsTYNAMp2UG3f92QK0lVodRLw+rEqiVcnYFmm1mVk+rAVknVsJ4HcQlfez++5OkAm0LYPAmId/djDkr9mCX13xbvWKXqSUfQuXAPRfB2pd5GC8ZIFFd1zJSEk0XcLjlVEclJ+xqECCcTv4V4CRlyQY0wBRgFETdcDlRI6/mad4migFt2bv3YFjJXZFXB6vtGvWD17Ilt2ccUrKV0Z3ZRsWo1itU5gGKtLcjBOclTSENBn1ojfRb05OBJgrID78a8+plkXrGzb32qaGjm5gNSbG2mtCrF7j40nuDE2jTIGl3YdmbVOpxZ1Tr2AHT82jq2XQdO/CwnlfrsmpWddVxWQ7rT8eRpH6uOnb9FBOU13VrHb7KM5WXrsct4L/kyKB0rTa1ZvpTj9X5LfGO4qnYOdXKQm3ROSWMuMYCbDOua0PC1cpJRpy1OyknWy+Mk9VjVdqo6xJFOIS0ZUmatY5NSzfV4bVz/nNrCPqtUPcAWp7+RLa7ry5azKtXheQ8+g+4nn1PBYl8W/FvI6bmv6nbcHJU0i6lbahNHvvisvgO8I1S8UXpVZyq9dEVn2ufWL/KK+1wcYexzO6LW7uAAEuZF7Dn9E5HEswBVfT38jjLk4td+PXLMUuZm/luflHTzH0yZV38A</diagram></mxfile>
diff --git a/readme.md b/readme.md
@@ -10,9 +10,21 @@ A project for presenting my professional work to the world in a single page appl
 
 The entire project follow the official convention for JS. It's checked everyime I compile the project by `EsLint`. Also, the project is checked by `travis` and the test of `Ava` for checking the continuity. Finally, the robustness of the project is assured by `Coveralls` who checked the coverage of the test.
 
+## Flowchart
+
+![Alt text](documentation/management/flowchart.jpg?raw=true "PORTFOLIO-Flowchart")
+
 ## Database ERD
 
-![Alt text](documentation/management/src/database.jpg?raw=true "PORTFOLIO-ERD")
+The database is centered around the articles/projects. It's the main purpose of this project :
+
+![Alt text](documentation/management/database.jpg?raw=true "PORTFOLIO-ERD")
+
+## Development cycle
+
+I am developing following an easy to understand cycle. This way I am sure to not destroy everything that has been done with a new functionnality :
+
+![Alt text](documentation/management/cycle.jpg?raw=true "PORTFOLIO-CYCLE")
 
 ## Prerequisite
 
@@ -26,8 +38,6 @@ https://nodejs.org/en/download/
 MongoDB
 ```
 
-In the futur, I will use Docker for having this step cut.
-
 ## Installation
 
 After cloning the project, you can install all the dependencies of the project by running this command at the root of the project :