Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 1.52 KB

README.md

File metadata and controls

74 lines (53 loc) · 1.52 KB
Raw

README.md

A powerful application specification generator powered by Claude AI. This tool helps the user create comprehensive, structured specifications for their applications using only a simple, natural language, input.

Features

  • 🤖 AI-Powered Specification Generation
  • 🔒 Secure API Key Management
  • 📝 Detailed, Structured Output
  • 🎨 Modern UI with shadcn/ui Components

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (v18 or higher)
  • npm (comes with Node.js)
  • A Claude API key from Anthropic

Installation

  1. Clone the repository:
git clone https://github.com/rustyorb/app-spec-generator.git
cd app-spec-generator
  1. Install dependencies:
npm install
  1. Start the development server:
npm run dev

Usage

  1. Configure your Claude API key:

    • Click on the API Configuration card
    • Enter your Claude API key
    • Click "Save Key"

  2. Generate a specification:

    • Enter your app description in the text area
    • Click "Generate Specification"
    • View the structured output below

Tech Stack

  • Vite
  • React
  • TypeScript
  • Tailwind CSS
  • shadcn/ui
  • Claude AI API

Development

To contribute to this project:

  1. Fork the repository
  2. Create a feature branch
  3. Commit your changes
  4. Push to the branch
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

If you encounter any issues or have questions, please open an issue in the GitHub repository.