diff --git a/docs/ecolyo/project_architecture/architecture.md b/docs/ecolyo/project_architecture/architecture.md index 26f2105bdccaf37c202519169b1d4bf3c8336fc3..8943d8a1544e8a66a0cbcc7e61f3cd1eff3d0372 100644 --- a/docs/ecolyo/project_architecture/architecture.md +++ b/docs/ecolyo/project_architecture/architecture.md @@ -1,84 +1,7 @@ -## Libraries +# Architecture -For this project, we use the libraries below: +## Principle diagram -###React +The principle diagram below describes the responsibilities of each application brick. -Library to create user interfaces. -Design simple views for each state in your application, and React will efficiently update and render just the right components when your data changes. - -Build encapsulated components that manage their own state, then compose them to make complex UIs. - -Since component logic is written in JavaScript instead of templates, you can easily pass rich data through your app and keep state out of the DOM - -###React Redux - -It is a predictable state container. - -It is implemented for a better management of the states because it allows to centralize all the states and the logic of the application. -It lets a react component read data from a Redux store, and dispatch actions to the store to update data. - -###Axios - -HTTP client library - -It allows to send HTTP request and manage the responses. - -###Lodash - -javascript utility library - -Lodash'modular method are great for: - -- Iterating arrays, objects, & strings -- Manipulating & testing values -- Creating composite functions - -###Moment - -Date library to parse, validate, manipulate, and display dates and times in JavaScript. - -###Luxon - -Wrapper for Javascript dates and times. - -###Jest - -Testing library - -It allows to evaluate functionnalities of an app to ensure that the product is defect-free in order to produce the quality product. - -###Enzyme - -Testing utility for React - -It makes it easier to test your React Components' output. You can also manipulate, traverse, and in some ways simulate runtime given the output. - -###Sass - -CSS preprocessor - -It allows us to easily manage large CSS files and split across different files. -It allows us to create variables, nested rules, mixins, functions, and do mathematical calculations. - -###Material UI - -It allows to create react component that implements Google's material design - -###D3 - -It allows to manipulate documents based on data. -It combines visualization components and a data-driven approach to DOM manipulation. - -###React-swipeable-views - -It is a React component to make swipeable views - -###React-lottie - -Lottie Animation View for React. -It allows app to use animations easily. - -###Husky - -It is used to improve your commit. + diff --git a/docs/ecolyo/project_architecture/cozy.md b/docs/ecolyo/project_architecture/cozy.md deleted file mode 100644 index 2f4f692dba5c6228a0130fccce621b4c7e2d7452..0000000000000000000000000000000000000000 --- a/docs/ecolyo/project_architecture/cozy.md +++ /dev/null @@ -1,2 +0,0 @@ -!!! info "" - :construction: Section under Construction :construction: \ No newline at end of file diff --git a/docs/ecolyo/project_architecture/libraries.md b/docs/ecolyo/project_architecture/libraries.md new file mode 100644 index 0000000000000000000000000000000000000000..227c6e9615e03088c8b3f95b345277decaee028f --- /dev/null +++ b/docs/ecolyo/project_architecture/libraries.md @@ -0,0 +1,84 @@ +# Libraries + +For this project, we use the libraries below: + +## React + +Library to create user interfaces. +Design simple views for each state in your application, and React will efficiently update and render just the right components when your data changes. + +Build encapsulated components that manage their own state, then compose them to make complex UIs. + +Since component logic is written in JavaScript instead of templates, you can easily pass rich data through your app and keep state out of the DOM + +## React Redux + +It is a predictable state container. + +It is implemented for a better management of the states because it allows to centralize all the states and the logic of the application. +It lets a react component read data from a Redux store, and dispatch actions to the store to update data. + +## Axios + +HTTP client library + +It allows to send HTTP request and manage the responses. + +## Lodash + +javascript utility library + +Lodash'modular method are great for: + +- Iterating arrays, objects, & strings +- Manipulating & testing values +- Creating composite functions + +## Moment + +Date library to parse, validate, manipulate, and display dates and times in JavaScript. + +## Luxon + +Wrapper for Javascript dates and times. + +## Jest + +Testing library + +It allows to evaluate functionnalities of an app to ensure that the product is defect-free in order to produce the quality product. + +## Enzyme + +Testing utility for React + +It makes it easier to test your React Components' output. You can also manipulate, traverse, and in some ways simulate runtime given the output. + +## Sass + +CSS preprocessor + +It allows us to easily manage large CSS files and split across different files. +It allows us to create variables, nested rules, mixins, functions, and do mathematical calculations. + +## Material UI + +It allows to create react component that implements Google's material design + +## D3 + +It allows to manipulate documents based on data. +It combines visualization components and a data-driven approach to DOM manipulation. + +##React-swipeable-views + +It is a React component to make swipeable views + +## React-lottie + +Lottie Animation View for React. +It allows app to use animations easily. + +## Husky + +It is used to improve your commit. diff --git a/docs/img/architecture/cozy-architecture-principles.png b/docs/img/architecture/cozy-architecture-principles.png new file mode 100644 index 0000000000000000000000000000000000000000..30b67b9cadc17cc4e223c4b9a63c5eef860b6420 Binary files /dev/null and b/docs/img/architecture/cozy-architecture-principles.png differ diff --git a/mkdocs.yml b/mkdocs.yml index f6441359a97fb88df165d5285ced19901f0bdca3..8a682782d3df81277f1718e843f3767a00644bf4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -35,7 +35,7 @@ nav: - Launch a konnector on local: ecolyo/getting_started/launch_local_konnector.md - Project Architecture: - Architecture: ecolyo/project_architecture/architecture.md - - Cozy: ecolyo/project_architecture/cozy.md + - Libraries: ecolyo/project_architecture/libraries.md - Environments: ecolyo/project_architecture/environments.md - DocTypes: ecolyo/project_architecture/doctypes.md - Application: