max/pm-template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

clean up README: tighter, no duplication

Browse Source
This commit is contained in:
Max Mayfield
2026-02-27 07:06:50 +00:00
parent ae9b04d9f5
commit d88fd856f8
1 changed files with 15 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@@ -1,14 +1,12 @@
# Reltio PM Factory # Reltio PM Factory
A browser-based AI workspace for Product Managers. No terminal required after initial setup. A CLI-agnostic AI workspace for Product Managers. Pre-loaded with Transparent Factory standards, BMad Creative Suite, Jira/Aha!/Gainsight integrations, and epic-writing skills.
**Forge Console** gives you a familiar chat interface backed by [Codex](https://github.com/openai/codex), pre-loaded with Reltio's Transparent Factory standards, BMad Creative Suite, Jira/Aha!/Gainsight integrations, and epic-writing skills.
--- ---
## Quick Start ## Quick Start
### Option 1: Docker (recommended) ### Docker (recommended)
```bash ```bash
git clone <this-repo> pm-template git clone <this-repo> pm-template
cd pm-template cd pm-template
@@ -17,26 +15,26 @@ docker compose up -d
``` ```
Open http://localhost:3000. Open http://localhost:3000.
### Option 2: Local ### Local (no Docker)
```bash ```bash
git clone <this-repo> pm-template git clone <this-repo> pm-template
cd pm-template cd pm-template
./start.sh ./start.sh
``` ```
On first run, the script checks Node.js, creates `.env`, installs deps, and opens the browser. ### Open WebUI
Use the drop-in artifacts in `openwebui/` to connect any Open WebUI instance.
See [`openwebui/SETUP.md`](openwebui/SETUP.md).
### Any CLI Agent
Open the repo in Cursor, Claude Code, Kiro, Codex, or Gemini CLI. They all read `AGENTS.md`.
--- ---
## Prerequisites (One-Time Setup) ## One-Time Setup
Before the AI agent can connect to your tools, you need: 1. **Jira** — Run `mcporter auth atlassian` once to complete OAuth.
2. **API Keys** — Edit `.env` with your Aha! and Gainsight PX credentials.
1. **Git & Bitbucket Access** — A working SSH key configured with Bitbucket.
2. **Jira Authentication** — Run `mcporter auth atlassian` in a terminal once to complete the OAuth flow.
3. **API Keys** — Edit `.env` with your Aha! and Gainsight PX credentials.
Once authenticated, the Forge Console handles everything else.
--- ---
@@ -44,41 +42,13 @@ Once authenticated, the Forge Console handles everything else.
| Component | Purpose | | Component | Purpose |
|-----------|---------| |-----------|---------|
| `web/` | Forge Console — local chat UI + Express server | | `web/` | Forge Console — local chat UI (Express + WebSocket → Codex) |
| `skills/epics-standards/` | Epic creation templates & Aha! workflows | | `openwebui/` | Open WebUI preset, pipelines, and knowledge manifest |
| `skills/factory-standards/` | Transparent Factory tenet sync & compliance | | `skills/` | Epics, Factory Standards, BMad Creative Suite, Gainsight PX |
| `skills/bmad-suite/` | BMad Creative Intelligence Suite (brainstorming, design thinking, storytelling) |
| `skills/gainsight-px/` | Product analytics queries |
| `config/mcporter.json` | MCP server definitions (Jira, Aha!, Context7) | | `config/mcporter.json` | MCP server definitions (Jira, Aha!, Context7) |
--- ---
## For AI Agents
If you are an AI assistant reading this repo, see `AGENTS.md` for your operating instructions.
---
## Frontend Options
This repo is CLI-agnostic. Use whichever interface fits your team:
### Option A: Forge Console (built-in)
A lightweight local chat UI that wraps Codex CLI.
```bash
./start.sh # opens http://localhost:3000
```
### Option B: Open WebUI (recommended)
Use the pre-built artifacts in `openwebui/` to connect any Open WebUI instance.
Includes model presets, RAG knowledge manifests, and tool pipelines.
See [`openwebui/SETUP.md`](openwebui/SETUP.md) for details.
### Option C: Any CLI Agent
Open the repo in Cursor, Claude Code, Kiro, Gemini CLI, or any agent that reads `AGENTS.md`.
---
## Architecture ## Architecture
``` ```