Skip to content

Commit 19de35c

Browse files
committed
doc
1 parent 2c65aea commit 19de35c

File tree

1 file changed

+32
-24
lines changed

1 file changed

+32
-24
lines changed

architecture.md

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,49 @@
22

33
## Files tree
44

5-
List of main files to develop.
5+
Main project structure:
66

77
```
88
.
9-
├── controllers/
9+
├── app.js CLI entry point, command root
10+
├── controllers/ Business logic controllers
1011
├── core/
11-
│ ├── frontend Web browser files: JS, CSS
12-
│ ├── models Business models and unit tests
13-
│ ├── utils Business functions and unit tests
14-
│ └── i18n.yml
12+
│ ├── frontend/ Browser files: JS, CSS, UI components
13+
│ ├── models/ Business models and unit tests
14+
│ ├── utils/ Utility functions and unit tests
15+
│ └── i18n.yml Translation file
1516
├── docs/ User documentation
1617
├── e2e/
17-
│ ├── **/config.yml Options for each export
18-
│ ├── exec-modelize.sh Series of commands to generate exports to execute E2E tests
19-
│ └── **.cy.js Cypress E2E testing files
18+
│ ├── cypress.config.js Cypress configuration file
19+
│ ├── e2e-support.js Cypress support utilities
20+
│ ├── exec-modelize.sh Shell script for E2E export automation
21+
│ ├── *.cy.js Cypress test files
22+
│ └── jsconfig.json Node.js config for tests
23+
├── man/ Manual pages and related scripts
2024
├── static/
21-
│ ├── icons Images
22-
│ └── template Contains app exports (cosmoscope, report) templates
23-
├── app.js Root, CLI commands rooting
24-
├── webpack-back.config.mjs Webpack config to build executable (JS+raw)
25-
├── webpack-front.config.mjs Webpack config to build frontend bundle (JS+CSS)
26-
27-
├── temp/ E2E tests exports
28-
└── dist/ Webpack bundles
29-
└── back.cjs App executable
25+
│ ├── icons/ Images and icons
26+
│ └── template/ Export templates (cosmoscope, report)
27+
├── temp/ Temporary exports for E2E tests
28+
├── dist/ Webpack bundles
29+
│ └── back.cjs Main executable
30+
├── babel.config.js Babel configuration
31+
├── jest.config.js Jest configuration
32+
├── package.json NPM dependencies and scripts
33+
├── README.md Main documentation
34+
├── webpack-back.config.mjs Webpack backend config
35+
└── webpack-front.config.mjs Webpack frontend config
3036
```
3137

3238
## Environments
3339

34-
📁 /cosma/
35-
├── jsconfig.json Node.js ESM (code source backend)
36-
├── 📁 core/frontend/
37-
│ └── jsconfig.json Browser ESM (code frontend)
38-
└── 📁 e2e/
39-
└── jsconfig.json Node.js CommonJS (tests Cypress)
40+
Project environments:
41+
42+
```
43+
.
44+
├── jsconfig.json Node.js ESM config (backend source code)
45+
├── core/frontend/jsconfig.json Browser ESM config (frontend code)
46+
└── e2e/jsconfig.json Node.js CommonJS config (Cypress tests)
47+
```
4048

4149
## Published tree
4250

0 commit comments

Comments
 (0)