add contributing guidelines
+15
-5
+2
-5
.vscode/launch.json
+2
-5
.vscode/launch.json
···
7
7
"program": "${workspaceFolder}/main.go",
8
8
"args": [
9
9
"up",
10
-
"--ssh-addr",
11
-
":2222"
10
+
"--ssh-addr=:2222",
12
11
],
13
12
"env": {
14
13
"SMALLWEB_DIR": "${workspaceFolder}/examples"
···
20
19
"request": "launch",
21
20
"program": "${workspaceFolder}/main.go",
22
21
"console": "integratedTerminal",
23
-
"args": [
24
-
"logs"
25
-
],
22
+
"args": [],
26
23
"env": {
27
24
"SMALLWEB_DIR": "${workspaceFolder}/examples"
28
25
},
+13
CONTRIBUTING.md
+13
CONTRIBUTING.md
···
1
+
# Contributing to the project
2
+
3
+
You'll need to proxy requests from `*.smallweb.localhost:443` to `localhost:7777` to run the project locally. The easiest to achieve is to use the following caddyfile:
4
+
5
+
```sh
6
+
smallweb.localhost, *.smallweb.localhost {
7
+
reverse_proxy localhost:7777
8
+
}
9
+
```
10
+
11
+
You can follow the instructions from the [docs](https://www.smallweb.run/docs/hosting/local/) to find out how to install caddy locally.
12
+
13
+
Then, all debug commands will use the example workspace located in the `examples` folder.