@jmp-technologies/analytics 0.1.0 → 0.1.1
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/README.md +26 -3
- package/package.json +16 -1
package/README.md
CHANGED
|
@@ -1,7 +1,30 @@
|
|
|
1
1
|
# `@jmp-technologies/analytics`
|
|
2
2
|
|
|
3
|
-
Browser client for **`POST {baseUrl}/api/events`**.
|
|
3
|
+
Browser client for **`POST {baseUrl}/api/events`**.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## New client website (full process)
|
|
6
6
|
|
|
7
|
-
**
|
|
7
|
+
1. Deploy **JMP Analytics** (jmp-dashboard) to a stable **HTTPS** URL.
|
|
8
|
+
2. Create a **website** row (domain + **tracking_key**) and assign it to the client user.
|
|
9
|
+
3. On the client site: **`npm install @jmp-technologies/analytics`**, set **`NEXT_PUBLIC_JMP_ANALYTICS_URL`** and **`NEXT_PUBLIC_JMP_TRACKING_KEY`**, wire **`trackPageView`** (and optional events).
|
|
10
|
+
4. Verify **`POST /api/events`** returns **201** and data appears in the dashboard.
|
|
11
|
+
|
|
12
|
+
**Step-by-step checklist:** [Client onboarding](https://github.com/jmp-technologies/jmp-dashboard/blob/main/docs/client-onboarding.md)
|
|
13
|
+
|
|
14
|
+
**API, CORS, examples:** [Tracking integration](https://github.com/jmp-technologies/jmp-dashboard/blob/main/docs/tracking-integration.md)
|
|
15
|
+
|
|
16
|
+
If your GitHub org/repo name differs, replace `jmp-technologies/jmp-dashboard` in those URLs.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## Monorepo / local docs
|
|
21
|
+
|
|
22
|
+
From this repo, the same files are at **`docs/client-onboarding.md`** and **`docs/tracking-integration.md`**.
|
|
23
|
+
|
|
24
|
+
## Build
|
|
25
|
+
|
|
26
|
+
`npm run build` in this package (or root `prepare` after `npm install`).
|
|
27
|
+
|
|
28
|
+
## Publish to npm (org `jmp-technologies`)
|
|
29
|
+
|
|
30
|
+
`npm publish` from this directory after `npm run build` (package sets `publishConfig.access` to `public`).
|
package/package.json
CHANGED
|
@@ -1,8 +1,23 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@jmp-technologies/analytics",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Browser client for JMP Analytics event ingestion",
|
|
5
5
|
"license": "UNLICENSED",
|
|
6
|
+
"keywords": [
|
|
7
|
+
"jmp",
|
|
8
|
+
"analytics",
|
|
9
|
+
"tracking",
|
|
10
|
+
"jmp-analytics"
|
|
11
|
+
],
|
|
12
|
+
"repository": {
|
|
13
|
+
"type": "git",
|
|
14
|
+
"url": "git+https://github.com/jmp-technologies/jmp-dashboard.git",
|
|
15
|
+
"directory": "packages/jmp-technologies-analytics"
|
|
16
|
+
},
|
|
17
|
+
"homepage": "https://github.com/jmp-technologies/jmp-dashboard/tree/main/packages/jmp-technologies-analytics#readme",
|
|
18
|
+
"bugs": {
|
|
19
|
+
"url": "https://github.com/jmp-technologies/jmp-dashboard/issues"
|
|
20
|
+
},
|
|
6
21
|
"type": "module",
|
|
7
22
|
"main": "./dist/index.cjs",
|
|
8
23
|
"module": "./dist/index.js",
|