From 829dcf5204ae1be6c2e170fadeecfe2a63828f86 Mon Sep 17 00:00:00 2001 From: FORESTIER Fabien <fabien.forestier@soprasteria.com> Date: Fri, 24 Jan 2020 14:40:36 +0100 Subject: [PATCH] Add some info about the modules of the webapp --- docs/components/custom-apps/web-app.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/components/custom-apps/web-app.md b/docs/components/custom-apps/web-app.md index 0b7814a..e018091 100644 --- a/docs/components/custom-apps/web-app.md +++ b/docs/components/custom-apps/web-app.md @@ -9,17 +9,19 @@ Here is our `/src` folder structure:  * `src/app/`: where the Angular code is located. With time we organized this part in different modules each taking care of one main functionnality. Here is the list of the modules: - * `core/`: - * `dataset-details/`: - * `datasets/`: - * `editorialisation/`: - * `elasticsearch/`: - * `map/`: - * `shared/`: - * `user/`: + * `core/`: constitutes the base of the application (layout, notifications, navigation history...) + * `dataset-details/`: contains the components and logic allowing the display of a dataset information (metadata, data, map...) + * `datasets/`: contains the components and some of the logic related to the research + * `editorialisation/`: contains the components and logic related to the display of editorial content (static pages, articles) + * `elasticsearch/`: + * `map/`: contains the components and logic allowing the display and manipulation of a map + * `shared/`: provides components, directives and others things that can be reused in different modules + * `user/`: contains the components and logic related to the user management in the application (login, logout, user profil...) * `src/assets/`: contains all the images, favicon, svg, fonts, dynamic config file... -* `src/environments/`: contains files with static configuraton. -* `src/i18n/`: +* `src/environments/`: contains files with static configuration. +* `src/i18n/`: this folder is dedicated to the translation. The are two types of files: + * `.xlf`: + * `.ts`: * `src/scss/`: * `src/app-routing.module.ts`: * `src/app.component(.ts, .html, .scss)`: -- GitLab