Skip to content

Commit 16fac3a

Browse files
committed
improve contribution guidelines
1 parent e92f7ed commit 16fac3a

File tree

2 files changed

+8
-11
lines changed

2 files changed

+8
-11
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
# Contributing to the project
22

3-
You'll need to proxy requests from `https://*.smallweb.localhost:443` to `http://localhost:7777` to run the project locally. We'll use caddy to do that.
4-
5-
First, you'll need to install caddy. Then, make sure to add the caddy root certificate to your system's trust store by running `sudo caddy trust`. Finally, use `sudo caddy run` at the root of the project to start the reverse proxy.
6-
7-
If you're using MacOS, you'll also need to create the `/etc/resolver/localhost` file with the following content:
8-
93
```sh
10-
nameserver 127.0.0.1
11-
```
4+
# start the reverse proxy
5+
caddy trust
6+
caddy run
127

13-
Then, all debug commands will use the example workspace located in the `examples` folder.
8+
# start the smallweb server
9+
cd example && smallweb up
10+
```

Caddyfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
smallweb.live, *.smallweb.live {
2-
tls internal
3-
reverse_proxy localhost:7777
2+
tls internal
3+
reverse_proxy localhost:7777
44
}

0 commit comments

Comments
 (0)