prd-gen 0.1.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/README.md ADDED
@@ -0,0 +1,52 @@
1
+ # prd-gen
2
+
3
+ A CLI tool for reviewing PRDs (Product Requirements Documents) one user story at a time. Assign priorities, edit stories, add or delete entries — all saved back to `prd.json`.
4
+
5
+ ## Prerequisites
6
+
7
+ - [Node.js](https://nodejs.org/) v18 or later
8
+ - npm
9
+
10
+ ## Install dependencies
11
+
12
+ ```bash
13
+ npm install
14
+ ```
15
+
16
+ ## Usage
17
+
18
+ ### Run in development mode
19
+
20
+ ```bash
21
+ npm run dev
22
+ ```
23
+
24
+ ### Build and run
25
+
26
+ ```bash
27
+ npm run build
28
+ npm start
29
+ ```
30
+
31
+ The app starts a local server on [http://localhost:3000](http://localhost:3000) and opens the PRD review UI in your browser.
32
+
33
+ ## Data file
34
+
35
+ The tool reads and writes user stories from `prd.json` in the current working directory. The file should have the following shape:
36
+
37
+ ```json
38
+ {
39
+ "project": "my-project",
40
+ "description": "...",
41
+ "userStories": []
42
+ }
43
+ ```
44
+
45
+ ## Scripts
46
+
47
+ | Command | Description |
48
+ |---------|-------------|
49
+ | `npm run dev` | Run directly with `tsx` (no build step) |
50
+ | `npm run build` | Compile TypeScript to `dist/` |
51
+ | `npm start` | Run the compiled output |
52
+ | `npm run typecheck` | Type-check without emitting files |
@@ -0,0 +1,7 @@
1
+ #!/usr/bin/env node
2
+ /**
3
+ * prd-gen CLI entry point
4
+ * Single-story-at-a-time PRD review tool
5
+ */
6
+ export {};
7
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA;;;GAGG"}