dev: documented file organization
Massimo Melina committed
Sep 7, 2023 at 09:49 UTC
6f59bad74c9850e3fd929f789592b275c6c5347d
1 file changed
+13
dev.md
+13
@@ -29,6 +29,19 @@ To run tests
29
30
Alternatively you can run a development server, just be sure to load config from `tests` folder.
31
32
+# File organization
33
+
34
+The project is roughly divided in Server + Frontend + Admin, where Frontend is a web interface intended to access
35
+shared files, while Admin is the web interface for configuration/administration.
36
+Server lies in the root of the project, with its "src" folder, while Frontend and Admin are inside folders "frontend"
37
+and "admin" respectively, with their "src" folder within.
38
+
39
+Additionally, you have the following folders:
40
+- mui-grid-form: a lib used by Admin to easily build forms
41
+- plugins: a collection of plugins that are pre-installed
42
+- shared: code shared between Frontend and Admin
43
+- tests: automated tests with related resources
44
+
45
# Known problems
46
- vite's proxying server (but also CRA's) doesn't play nicely with SSE, leaving sockets open
47