red-pen-hub 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +114 -0
- package/package.json +30 -0
- package/sources.example.json +20 -0
- package/src/public/board.html +1305 -0
- package/src/public/favicon.svg +8 -0
- package/src/server.js +861 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Lincoln Tracy
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# Red Pen Hub
|
|
2
|
+
|
|
3
|
+
The Red Pen PRO combined project board. One local screen that aggregates your
|
|
4
|
+
Red Pen review notes from every project and every surface - WordPress, Express,
|
|
5
|
+
the static drop-in, Blender - and lets you filter, search, resolve, and jump to
|
|
6
|
+
the source.
|
|
7
|
+
|
|
8
|
+
Each individual site keeps its own Red Pen overlay, notes, and export - all free
|
|
9
|
+
and complete. The Hub is the cross-project cockpit: everything open, everywhere,
|
|
10
|
+
on one screen, with two-way status write-back.
|
|
11
|
+
|
|
12
|
+
- **Local-first.** Runs on your machine and only reads stores you point it at.
|
|
13
|
+
- **No SaaS, no phone-home, no account.** Nothing leaves your box.
|
|
14
|
+
- **Loopback-only.** Binds `127.0.0.1` / `::1` and is never reachable from the LAN.
|
|
15
|
+
|
|
16
|
+
## Quick start
|
|
17
|
+
|
|
18
|
+
Run it with no install:
|
|
19
|
+
|
|
20
|
+
```
|
|
21
|
+
npx red-pen-hub
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Then open http://localhost:3900
|
|
25
|
+
|
|
26
|
+
Or from a clone:
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
npm install
|
|
30
|
+
npm start
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Where your data lives
|
|
34
|
+
|
|
35
|
+
The Hub keeps all of its state in a per-user data directory, **not** next to its
|
|
36
|
+
own code - so it runs cleanly from an `npx` cache or a packaged binary:
|
|
37
|
+
|
|
38
|
+
- **Windows:** `%APPDATA%\red-pen-hub\`
|
|
39
|
+
- **macOS / Linux:** `$XDG_CONFIG_HOME/red-pen-hub/` (else `~/.config/red-pen-hub/`)
|
|
40
|
+
|
|
41
|
+
Set `RED_PEN_HUB_DATA` to override the location (portable installs, testing).
|
|
42
|
+
That folder holds `sources.json` (your source list, the connect token, and your
|
|
43
|
+
license key) and `connected/` (push-store data). The credential file is written
|
|
44
|
+
`0600`. Upgrading from an older in-folder version migrates your state
|
|
45
|
+
automatically on first run.
|
|
46
|
+
|
|
47
|
+
## Adding projects
|
|
48
|
+
|
|
49
|
+
Three ways, all from the **Sources** tab:
|
|
50
|
+
|
|
51
|
+
- **Scan for projects** - point it at a dev folder and it finds every Red Pen
|
|
52
|
+
install of every type: `.redpen/notes.json` file stores (Express, static
|
|
53
|
+
export, Blender) and WordPress sites running the wp-red-pen plugin. Pick which
|
|
54
|
+
to add.
|
|
55
|
+
- **Connect a site (push)** - a site pushes its notes to the Hub and
|
|
56
|
+
self-registers; no "add" step needed. Used by the static drop-in and WP.
|
|
57
|
+
- **Edit `sources.json` by hand** - copy `sources.example.json` into your data
|
|
58
|
+
dir as `sources.json` and edit it:
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"port": 3900,
|
|
63
|
+
"sources": [
|
|
64
|
+
{ "type": "file", "label": "My App", "path": "C:/.../.redpen/notes.json" },
|
|
65
|
+
{ "type": "wp-rest", "label": "TDM", "url": "https://example.com",
|
|
66
|
+
"user": "username", "appPassword": "xxxx xxxx xxxx xxxx xxxx xxxx" }
|
|
67
|
+
]
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
WordPress sources authenticate with a standard Application Password and work for
|
|
72
|
+
both local and remote sites.
|
|
73
|
+
|
|
74
|
+
## Free vs PRO
|
|
75
|
+
|
|
76
|
+
The Hub is free to try with up to **3 projects** on the board - a real
|
|
77
|
+
try-before-you-buy, not a crippled demo. A PRO license lifts the cap to
|
|
78
|
+
unlimited projects.
|
|
79
|
+
|
|
80
|
+
- The license is an **offline, lifetime key** - verified locally against an
|
|
81
|
+
embedded public key. No phone-home, no expiry, no subscription.
|
|
82
|
+
- The **same key** unlocks the WordPress plugin and the Hub.
|
|
83
|
+
- To unlock: paste your key into the unlock panel on the board (or `POST` it to
|
|
84
|
+
`/api/license`). It is saved to your data dir.
|
|
85
|
+
|
|
86
|
+
Read the docs at **https://docs.redpen.tools**. PRO licensing is coming soon -
|
|
87
|
+
watch **https://redpen.tools**.
|
|
88
|
+
|
|
89
|
+
## What it does
|
|
90
|
+
|
|
91
|
+
- Aggregates notes from every source into one board, normalized to the shared
|
|
92
|
+
Red Pen note model.
|
|
93
|
+
- Filter by status / project / surface, full-text search, live counts.
|
|
94
|
+
- **Two-way write-back** - resolve or reopen a note from the board and the Hub
|
|
95
|
+
pushes the change back to its real source (file store, connected push store, or
|
|
96
|
+
the WP plugin's REST route). Hub-side changes survive the next push from a
|
|
97
|
+
connected site.
|
|
98
|
+
- Saved views, jump-to-source, Markdown export.
|
|
99
|
+
- Passive git status per project on the Sources tab (clean / dirty indicator).
|
|
100
|
+
|
|
101
|
+
## Security
|
|
102
|
+
|
|
103
|
+
- Binds loopback only (IPv4 + IPv6); never exposed to the network.
|
|
104
|
+
- Every `/api` route is gated by a per-install token; the board is served with
|
|
105
|
+
the token injected so its own fetches pass and nothing else on the box does.
|
|
106
|
+
- A Host allow-list rejects non-loopback `Host` headers (DNS-rebinding guard).
|
|
107
|
+
- URLs derived from source data are scheme-checked and redirects are
|
|
108
|
+
re-validated per hop.
|
|
109
|
+
|
|
110
|
+
## License
|
|
111
|
+
|
|
112
|
+
MIT for the code - it is open and readable. PRO is a paid unlock of the
|
|
113
|
+
unlimited-projects cap, not a lock on the source. By Lincoln Tracy. Part of the
|
|
114
|
+
Red Pen family - see https://redpen.tools.
|
package/package.json
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "red-pen-hub",
|
|
3
|
+
"version": "0.7.0",
|
|
4
|
+
"description": "Red Pen PRO - a local cross-project board that aggregates Red Pen review notes from every project and surface into one screen. No SaaS, no phone-home, local-first.",
|
|
5
|
+
"type": "commonjs",
|
|
6
|
+
"main": "src/server.js",
|
|
7
|
+
"bin": {
|
|
8
|
+
"red-pen-hub": "src/server.js"
|
|
9
|
+
},
|
|
10
|
+
"files": [
|
|
11
|
+
"src/",
|
|
12
|
+
"sources.example.json"
|
|
13
|
+
],
|
|
14
|
+
"scripts": {
|
|
15
|
+
"start": "node src/server.js"
|
|
16
|
+
},
|
|
17
|
+
"keywords": [
|
|
18
|
+
"red-pen",
|
|
19
|
+
"review",
|
|
20
|
+
"notes",
|
|
21
|
+
"dashboard",
|
|
22
|
+
"aggregator",
|
|
23
|
+
"dev-tools"
|
|
24
|
+
],
|
|
25
|
+
"author": "Lincoln Tracy",
|
|
26
|
+
"license": "MIT",
|
|
27
|
+
"dependencies": {
|
|
28
|
+
"express": "4.21.2"
|
|
29
|
+
}
|
|
30
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"port": 3900,
|
|
3
|
+
"discover": [
|
|
4
|
+
"C:/xampp/htdocs/library/Claude Code Projects"
|
|
5
|
+
],
|
|
6
|
+
"sources": [
|
|
7
|
+
{
|
|
8
|
+
"type": "file",
|
|
9
|
+
"label": "Example single file",
|
|
10
|
+
"path": "C:/path/to/some-app/.redpen/notes.json"
|
|
11
|
+
},
|
|
12
|
+
{
|
|
13
|
+
"type": "wp-rest",
|
|
14
|
+
"label": "Example WordPress site",
|
|
15
|
+
"url": "https://example.com",
|
|
16
|
+
"user": "your-wp-username",
|
|
17
|
+
"appPassword": "xxxx xxxx xxxx xxxx xxxx xxxx"
|
|
18
|
+
}
|
|
19
|
+
]
|
|
20
|
+
}
|