merged dev-guidelines.md into dev.md
Massimo Melina committed
Aug 29, 2022 at 11:55 UTC
a9ec4a2bdbe171d18fbcb672deaf139c701d9720
2 files changed
+20
-17
dev-guidelines.md
deleted
-17
@@ -1,17 +0,0 @@
1
-- All objects that go in yaml should use snake_case.
2
- - Reason: we want something that is both easy for the user and maps directly in our code.
3
- Spaces and kebab-case don't play well with javascript and camel is less readable for the user.
4
-
5
-# Project design
6
-- At the moment the admin interface was designed to be completely separated from the normal frontend for the following reasons
7
- - heavy separation improves security, as it's more unlikely for a bug in the frontend to expose admin commands
8
- - people interested in building a new frontend won't have to deal with the complexity and features of the admin interface
9
- - it's easier to keep the frontend smaller for faster load
10
-
11
- Of course this comes with a price to pay on the programmer's side, more work to do.
12
-
13
-# Syntax
14
-- For strings, I'm trying to use double-quotes or backticks for text that's read by the user, and single-quotes elsewhere.
15
-
16
-# Known problems
17
-- react-scripts server doesn't seem to play nicely with SSE, like sockets are left open
dev.md
+20
@@ -29,6 +29,26 @@ To run tests
29
30
Alternatively you can run a development server, just be sure to load config from `tests` folder.
31
32
+## Known problems
33
+- vite's proxying server (but also CRA's) doesn't play nicely with SSE, leaving sockets open
34
+- vite's building of react-projects (frontend & admin) produce non-working apps
35
+ - console shows exceptions on any hook invocation
36
+ - the problem seems to be related to libs being built with a separate instance of react
37
+
38
+## Guidelines
39
+
40
+- For strings, I'm trying to use double-quotes or backticks for text that's read by the user, and single-quotes elsewhere.
41
+- All objects that go in yaml should use snake_case.
42
+ - Reason: we want something that is both easy for the user and maps directly in our code.
43
+ Spaces and kebab-case don't play well with javascript and camel is less readable for the user.
44
+
45
+## Project design
46
+
47
+- At the moment the admin interface was designed to be completely separated from the "user" frontend
48
+ to keep the latter smaller and to allow alternative frontends creation without having to deal with the complexity of the admin interface.
49
+
50
+ Of course this comes with a price to pay on the programmer's side, more work to do.
51
+
52
## File formats
53
54
General configuration is read by default from file `config.yaml`.