You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: AGENTS.md
+5-3Lines changed: 5 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ Context for AI assistants working on this repo.
7
7
**tb-solid-pod** is a browser-based personal data pod inspired by the [Solid Project](https://solidproject.org/), built with [TinyBase](https://tinybase.org/) for reactive state and LocalStorage. It is **not** a real Solid server (no LDP, no WebID-TLS); it simulates Solid-style data (personas, contacts, groups, type indexes, file metadata) in a single-page app.
-**Data**: personas (WebID-style), contacts (including agents), groups (org/team/group), type indexes, virtual file system with metadata, settings/preferences.
10
+
-**Data**: personas (WebID-style), contacts (including agents), groups (org/team/group) with membership of contacts and your personas, type indexes, virtual file system with metadata, settings/preferences.
@@ -70,7 +70,9 @@ When someone wants to use this in an app they’re working on, point them to the
70
70
71
71
## Useful docs
72
72
73
-
-**README.md** – Overview, limitations, Use as a library (Zod + JSON Schema), Integration Guide (copy-paste vs install-from-GitHub), Getting Started (Node note, Live demo + 404 troubleshooting), CLI command list.
73
+
-**README.md** – Overview, limitations, Use as a library (Zod + JSON Schema), Integration Guide (copy-paste vs install-from-GitHub), Getting Started (Node note, Live demo + 404 troubleshooting), Testing (unit, BDD, Storybook link), CLI command list.
74
74
-**docs/CODING_GUIDELINES.md** – TypeScript (strict types, no sloppy types), short functions, simple React components, naming, file length.
Copy file name to clipboardExpand all lines: README.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ This library provides a complete foundation for **user-owned social data** in we
25
25
### Groups & Organizations
26
26
- Three group types: Organizations, Teams, and informal Groups
27
27
- W3C Organization Ontology (org:) vocabulary
28
-
- Membership management with contact linking
28
+
- Membership management: add contacts and your own personas to groups
29
29
- Group metadata: name, description, URL, logo
30
30
31
31
### File Storage with Metadata
@@ -47,7 +47,7 @@ This library provides a complete foundation for **user-owned social data** in we
47
47
- Persona schema includes optional `solid:publicTypeIndex` and `solid:privateTypeIndex` links
48
48
49
49
### Dual Interface
50
-
-**Graphical UI**: Tab-based navigation with forms and lists
50
+
-**Graphical UI**: Tab-based navigation with forms and lists. Personas, Contacts, and Groups tabs each have a **Create random** button that opens the form with sample data for quick try-out.
51
51
-**CLI Terminal**: Full command-line interface for power users
52
52
53
53
## Benefits for Social Applications
@@ -441,13 +441,14 @@ clear Clear terminal
441
441
## Testing
442
442
443
443
-**Unit tests (Vitest):**`npm test` or `npm run test:run`; coverage: `npm run test:coverage`
444
+
-**Storybook:**`npm run storybook` → http://localhost:6006 (component development). See [docs/testing/](docs/testing/README.md).
444
445
-**BDD / E2E (Playwright):** Generate specs from Gherkin, then run Playwright:
445
446
```bash
446
447
npx bddgen && npx playwright test
447
448
```
448
449
Or use the scripts: `npm run test:e2e` or `npm run test:bdd` (same thing). With browser visible: `npm run test:e2e:headed`.
449
450
450
-
**Start the server manually (recommended if E2E hangs):** In one terminal start the app; in another run the tests. Playwright will reuse the existing server on port 5173 (`reuseExistingServer` when not in CI).
451
+
**Start the server first (required):**The BDD/E2E command does not start the dev server. In one terminal start the app; in another run the tests.
451
452
1.**Terminal 1:**`npm run dev` — leave it running (app at http://localhost:5173).
Playwright will reuse the server on 5173 when not in CI. For a different port, set `E2E_BASE_URL` (e.g. `E2E_BASE_URL=http://localhost:3000 npx playwright test`).
39
+
For a different port, set `E2E_BASE_URL` (e.g. `E2E_BASE_URL=http://localhost:3000 npx playwright test`).
0 commit comments