AI Powered PRD Generator for AI Pair Programming
PRD Generator is a tool that leverages AI models (OpenAI GPT-4 and Anthropic Claude) to automatically generate Product Requirements Documents based on simple inputs. This project follows the Semantic Seed Venture Studio Coding Standards with a focus on code quality, security, and test-driven development.
- No-Auth Mode: Run the server without authentication for easy testing and development
- AI-Powered Generation: Uses OpenAI GPT-4 and Anthropic Claude for high-quality PRD generation
- Multiple Templates: Choose from CRUD, AI Agent, SaaS, or Custom templates
- Format Options: Generate PRDs in Markdown or JSON format
- Simple API: RESTful API with clear endpoints and documentation
- Basic Frontend: Modern web interface with Bootstrap 5 and EasyMDE for Markdown editing
prdgenerator/
├── frontend/ # Static frontend files
│ ├── css/ # Custom styles
│ ├── js/ # JavaScript modules
│ └── templates/ # HTML templates
├── no_auth_server.py # No-auth FastAPI server
├── requirements.txt # Python dependencies
└── .env # Environment variables
GET /api/v1/health
- Health check endpointPOST /api/v1/prd/generate
- Generate a new PRDGET /api/v1/prd
- List all generated PRDs
{
"title": "Product Name",
"input_prompt": "Product Description",
"template_type": "crud_application|ai_agent|saas_platform|custom",
"format": "markdown|json"
}
- Navigation: Responsive navbar with links to main features
- PRD Generation Form:
- Product Title input
- Product Description textarea
- Template Type selector
- Output Format selector
- Result Display:
- Markdown editor for viewing generated PRD
- Copy to clipboard functionality
- Download options (Markdown/JSON)
- Python 3.8 or higher
- Node.js 14 or higher (optional, for development)
- OpenAI API key
- Anthropic API key
- Clone the repository:
git clone <repository-url>
cd prdgenerator
- Create and activate virtual environment:
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
- Install dependencies:
pip install -r requirements.txt
- Create
.env
file:
OPENAI_API_KEY=your_openai_key_here
ANTHROPIC_API_KEY=your_anthropic_key_here
DEFAULT_MODEL_PROVIDER=openai
- Start the No-Auth Server:
python no_auth_server.py
The server will start on http://0.0.0.0:8888
- Start the Frontend:
cd frontend
python -m http.server 3001
Access the frontend at http://localhost:3001
- Navigate to http://localhost:3001/templates/generate.html
- Fill out the PRD generation form:
- Enter product title
- Provide detailed product description
- Select template type
- Choose output format
- Click "Generate PRD"
- View, copy, or download the generated PRD
-
Backend:
- FastAPI: Web framework
- Pydantic: Data validation
- OpenAI & Anthropic: AI providers
- python-dotenv: Environment management
-
Frontend:
- Bootstrap 5: UI framework
- EasyMDE: Markdown editor
- Native Fetch API: HTTP requests
Run the test suite:
pytest
- Follow the Semantic Seed Venture Studio Coding Standards
- Write tests for new features
- Update documentation as needed
- Submit pull requests with clear descriptions