Fork of github.com/did-method-plc/did-method-plc
update website build/docs
+20
-13
+7
-3
website/Makefile
+7
-3
website/Makefile
···
10
10
11
11
.PHONY: build
12
12
build: ## Build all executables
13
-
go build ./cmd/webplc
13
+
go build . -o webplc
14
14
15
15
.PHONY: test
16
16
test: ## Run all tests
···
34
34
check: ## Compile everything, checking syntax (does not output binaries)
35
35
go build ./...
36
36
37
+
.PHONY: sync-spec
38
+
sync-spec: ## Copies specs text from top level of git repo
39
+
cp -r ../spec/* ./spec/
40
+
37
41
.env:
38
42
if [ ! -f ".env" ]; then cp example.dev.env .env; fi
39
43
40
44
.PHONY: run-dev-webplc
41
-
run-dev-webplc: .env ## Runs 'bskyweb' for local dev
42
-
GOLOG_LOG_LEVEL=info go run ./cmd/webplc serve --debug
45
+
run-dev-webplc: .env ## Runs 'webplc' for local dev
46
+
GOLOG_LOG_LEVEL=info go run . serve --debug
+13
-10
website/README.md
+13
-10
website/README.md
···
1
1
2
-
`go-didplc`: did:plc in golang
3
-
==============================
2
+
`web.plc.directory`
3
+
===================
4
4
5
-
This golang package will eventually be an implementation of the did:plc specification in golang, including at a minimum verification of DID documents from a PLC operation log.
5
+
This is a basic website for the PLC directory, allowing lookup of individual DID documents.
6
6
7
-
For now it primarily contains a basic website for the PLC directory, allowing lookup of individual DID documents.
7
+
It also hosts a copy of the PLC specs. Due to a quirk of Go static file embedding, the specification files need to be copied from the top-level of this git repostiory every time there are edits:
8
+
9
+
```shell
10
+
make sync-specs
11
+
```
8
12
9
13
10
14
## Developer Quickstart
11
15
12
-
Install golang. We are generally using v1.20+.
16
+
Install golang. We are generally using v1.22+.
13
17
14
-
In this directory (`go-didplc/`):
18
+
In this directory (`website/`):
15
19
16
20
# re-build and run daemon
17
-
go run ./cmd/webplc serve
21
+
go run . serve
18
22
19
23
# build and output a binary
20
-
go build -o webplc ./cmd/webplc/
24
+
go build -o webplc .
21
25
22
-
The easiest way to configure the daemon is to copy `example.env` to `.env` and
23
-
fill in auth values there.
26
+
The easiest way to configure the daemon is to copy `example.env` to `.env` and fill in auth values there.