expanded instructions
Massimo Melina committed
Jan 20, 2022 at 15:55 UTC
8dc3c3ad4ff7840782e537e9240c2d5f4a9559ab
2 files changed
+15
-1
README.md
+14
@@ -109,6 +109,20 @@ Other options you can define as properties of an account:
109
1. Install Typescript: launch `npm -g i typescript`
110
3. Launch `npm run build-all` in the root
111
112
+You'll see some warnings about vulnerabilities. Fear not, for those are in the dev tools we are using.
113
+If you want to be assured, run `npm audit --production` that will exclude dev stuff, and you should see something
114
+more reassuring, like "found 0 vulnerabilities", hopefully.
115
+
116
+# Dev environment
117
+
118
+One way of working on sources here is to `npm run watch-server`.
119
+This will give you auto-restarting of the server on back-end changes.
120
+A good idea is to first clone/create your working config file, and set an env to point to it `HFS_CONFIG=/tmp/config.yaml`, so that your gitted config file is not changed.
121
+
122
+If you want to work on the front-end too, you should *first*
123
+1. set an env `FRONTEND_PROXY=3000`
124
+2. `npm run start-frontend`
125
+
126
# Plug-ins
127
128
We are slowly introducing a plug-ins system.
src/config.ts
+1
-1
@@ -9,7 +9,7 @@ const PATH = 'config.yaml'
9
let started = false
10
let state:Record<string,any> = {}
11
const emitter = new EventEmitter()
12
-const path = argv.config || process.env.hfs_config || PATH
12
+const path = argv.config || process.env.HFS_CONFIG || PATH
13
watchLoad(path, data => {
14
started = true
15
setConfig(data)