moved dev stuff down
Massimo Melina committed
Apr 1, 2022 at 12:38 UTC
3f00974f64bed55791bbd7c431ac13a3753f6bfd
1 file changed
+15
-13
README.md
+15
-13
@@ -56,7 +56,20 @@ If your system is not covered, you can try this alternative version:
56
3. chmod +x run
57
4. launch `./run`
58
59
-# Building instructions
59
+# Plug-ins
60
+
61
+We are slowly introducing a plug-ins system.
62
+Each plug-in is a sub-folder of `plugins` folder.
63
+You can quickly disable a plug-in by appending `-disabled` to the plug-in's folder name.
64
+Plug-ins can be hot-swapped, and at some extent can be edited without restarting the server.
65
+
66
+Each plug-in has access to the same set of features.
67
+Normally you'll have a plug-in that's a theme, and another that's a firewall,
68
+but nothing is preventing a single plug-in from doing both tasks.
69
+
70
+# Developers section
71
+
72
+## Building instructions
73
74
0. Install [Node.js](https://nodejs.org/) 16+
75
1. Install Typescript: launch `npm -g i typescript`
@@ -66,7 +79,7 @@ You'll see some warnings about vulnerabilities. Fear not, for those are in the d
79
If you want to be assured, run `npm audit --production` that will exclude dev stuff, and you should see something
80
more reassuring, like "found 0 vulnerabilities", hopefully.
81
69
-# Dev environment
82
+## Dev environment
83
84
One way of working on sources here is to `npm run watch-server`.
85
This will give you auto-restarting of the server on back-end changes.
@@ -82,17 +95,6 @@ Having this env-s will make the server get all related stuff from the other dev
95
Otherwise, you should be sure that frontend and admin have been built, and its files are ready to be used in `dist` folder.
96
In this latter case, the `DEV=1` you set before will make the server get the files from inside the `dist` folder.
97
85
-# Plug-ins
86
-
87
-We are slowly introducing a plug-ins system.
88
-Each plug-in is a sub-folder of `plugins` folder.
89
-You can quickly disable a plug-in by appending `-disabled` to the plug-in's folder name.
90
-Plug-ins can be hot-swapped, and at some extent can be edited without restarting the server.
91
-
92
-Each plug-in has access to the same set of features.
93
-Normally you'll have a plug-in that's a theme, and another that's a firewall,
94
-but nothing is preventing a single plug-in from doing both tasks.
95
-
98
## For plug-in makers
99
100
You should find some examples within your installation.