Skip to content

Commit 7a10118

Browse files
committed
WIP review
1 parent 14e030a commit 7a10118

File tree

7 files changed

+864
-429
lines changed

7 files changed

+864
-429
lines changed

Makefile

Lines changed: 44 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ help: ## Prints all the targets in all the Makefiles
1111
@echo "$(BOLD)$(CYAN)🌐 PATH (Path API & Toolkit Harness) Makefile Targets$(RESET)"
1212
@echo ""
1313
@echo "$(BOLD)=== 📋 Information & Discovery ===$(RESET)"
14-
@grep -h -E '^help:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
14+
@grep -h -E '^(help|help-unclassified):.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
1515
@echo ""
1616
@echo "$(BOLD)=== 🔨 Build & Run ===$(RESET)"
1717
@grep -h -E '^path_(build|run):.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
@@ -59,6 +59,49 @@ help: ## Prints all the targets in all the Makefiles
5959
@grep -h -E '^claudesync.*:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
6060
@echo ""
6161

62+
.PHONY: help-unclassified
63+
help-unclassified: ## Show all unclassified targets
64+
@echo ""
65+
@echo "$(BOLD)$(CYAN)📦 Unclassified Targets$(RESET)"
66+
@echo ""
67+
@grep -h -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | \
68+
grep -v -E '^(help|help-unclassified|portaldb-quickstart|path_build|path_run|path_up|path_down|config.*|install_tools.*|localnet_.*|load_test.*|test_unit|test_all|go_lint|e2e_test.*|bench.*|get_disqualified_endpoints|grove_get_disqualified_endpoints|shannon_preliminary_services_test_help|shannon_preliminary_services_test|source_shannon_preliminary_services_helpers|portal_db.*|proto.*|release_.*|go_docs|docusaurus.*|gen_.*_docs|test_request.*|test_healthz.*|test_disqualified.*|test_load.*|claudesync.*):.*?## .*$$' | \
69+
awk 'BEGIN {FS = ":.*?## "}; {printf "$(CYAN)%-40s$(RESET) %s\n", $$1, $$2}'
70+
@echo ""
71+
72+
.PHONY: portaldb-quickstart
73+
portaldb-quickstart: ## Quick start guide for Portal DB (starts services, hydrates data, tests endpoints)
74+
@echo ""
75+
@echo "$(BOLD)$(CYAN)🗄️ Portal DB Quick Start$(RESET)"
76+
@echo ""
77+
@echo "$(BOLD)Step 1: Starting Portal DB services...$(RESET)"
78+
@cd ./portal-db && make postgrest-up
79+
@echo ""
80+
@echo "$(BOLD)Step 2: Hydrating test data...$(RESET)"
81+
@cd ./portal-db && make hydrate-testdata
82+
@echo ""
83+
@echo "$(BOLD)Step 3: Testing public endpoint (networks)...$(RESET)"
84+
@curl -s http://localhost:3000/networks | jq
85+
@echo ""
86+
@echo "$(BOLD)Step 4: Generating JWT token...$(RESET)"
87+
@cd ./portal-db && make gen-jwt
88+
@echo ""
89+
@echo "$(BOLD)Step 5: Set your JWT token:$(RESET)"
90+
@echo "$(YELLOW)export TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYXV0aGVudGljYXRlZCIsImVtYWlsIjoiam9obkBkb2UuY29tIiwiZXhwIjoxNzU4MjEzNjM5fQ.i1_Mrj86xsdgsxDqLmJz8FDd9dd-sJhlS0vBQXGIHuU$(RESET)"
91+
@echo ""
92+
@echo "$(BOLD)Step 6: Testing authenticated endpoints...$(RESET)"
93+
@echo "$(CYAN)Testing portal_accounts:$(RESET)"
94+
@curl -s http://localhost:3000/portal_accounts -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYXV0aGVudGljYXRlZCIsImVtYWlsIjoiam9obkBkb2UuY29tIiwiZXhwIjoxNzU4MjEzNjM5fQ.i1_Mrj86xsdgsxDqLmJz8FDd9dd-sJhlS0vBQXGIHuU" | jq
95+
@echo ""
96+
@echo "$(CYAN)Testing rpc/me:$(RESET)"
97+
@curl -s http://localhost:3000/rpc/me -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiYXV0aGVudGljYXRlZCIsImVtYWlsIjoiam9obkBkb2UuY29tIiwiZXhwIjoxNzU4MjEzNjM5fQ.i1_Mrj86xsdgsxDqLmJz8FDd9dd-sJhlS0vBQXGIHuU" -H "Content-Type: application/json" | jq
98+
@echo ""
99+
@echo "$(BOLD)Step 7: Testing portal app creation...$(RESET)"
100+
@cd ./portal-db && make test-portal-app
101+
@echo ""
102+
@echo "$(GREEN)$(BOLD)✅ Quick start complete!$(RESET)"
103+
@echo ""
104+
62105
#############################
63106
#### PATH Build Targets ###
64107
#############################

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,18 @@ For Bug Reports and Enhancement Requests, please open an [Issue](https://github.
3535

3636
For Technical Support please open a ticket in [Grove's Discord](https://discord.gg/build-with-grove).
3737

38+
## Portal DB
39+
40+
The portal DB is the source of truth for running a SaaS using PATH to deploy
41+
a service similar to [Grove's Portal](https://portal.grove.city)
42+
43+
See the following docs for more information:
44+
45+
- [portal-db](./portal-db/README.md)
46+
- [portal-db/api](./portal-db/api/README.md)
47+
- [portal-db/sdk/go](./portal-db/sdk/go/README.md)
48+
- [portal-db/sdk/typescript](./portal-db/sdk/typescript/README.md)
49+
3850
---
3951

4052
## License

docusaurus/docusaurus.config.js

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ const config = {
1414

1515
markdown: {
1616
mermaid: true,
17+
hooks: {
18+
onBrokenMarkdownLinks: "warn",
19+
},
1720
},
1821
themes: [
1922
"@docusaurus/theme-mermaid",
@@ -36,7 +39,6 @@ const config = {
3639
baseUrl: "/",
3740

3841
onBrokenLinks: "throw",
39-
onBrokenMarkdownLinks: "warn",
4042

4143
i18n: {
4244
defaultLocale: "en",

docusaurus/package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@
1414
"write-heading-ids": "docusaurus write-heading-ids"
1515
},
1616
"dependencies": {
17-
"@docusaurus/core": "^3.8.1",
18-
"@docusaurus/preset-classic": "^3.8.1",
19-
"@docusaurus/theme-mermaid": "^3.8.1",
17+
"@docusaurus/core": "^3.9.1",
18+
"@docusaurus/preset-classic": "^3.9.1",
19+
"@docusaurus/theme-mermaid": "^3.9.1",
2020
"@easyops-cn/docusaurus-search-local": "^0.46.1",
2121
"@mdx-js/react": "^3.0.0",
2222
"clsx": "^2.0.0",
@@ -31,8 +31,8 @@
3131
"remark-mermaid-plugin": "^1.0.2"
3232
},
3333
"devDependencies": {
34-
"@docusaurus/module-type-aliases": "^3.8.1",
35-
"@docusaurus/types": "^3.8.1"
34+
"@docusaurus/module-type-aliases": "^3.9.1",
35+
"@docusaurus/types": "^3.9.1"
3636
},
3737
"browserslist": {
3838
"production": [

0 commit comments

Comments
 (0)