Release Notes by AI 🤖

Generate beautiful, professional release notes for your projects using AI. This tool helps developers and teams automatically create meaningful release notes from their code changes.

Features ✨

• 🎯 AI-powered release notes generation
• 🤖 Multiple AI model support (OpenAI GPT and Anthropic Claude)
• 🔄 Model switching capability
• 💻 Modern React + TypeScript implementation
• 🎨 Beautiful UI with Tailwind CSS and Radix UI components
• 📋 Easy copy-to-clipboard functionality
• 🌓 Dark/Light mode support
• 📱 Responsive design
• 🔍 GitHub integration for repository analysis

Tech Stack 🛠️

• React - UI Framework
• TypeScript - Type Safety
• Vite - Build Tool
• Tailwind CSS - Styling
• Radix UI - UI Components
• React Query - Data Fetching
• React Router - Routing
• React Hook Form - Form Management
• Zod - Schema Validation
• OpenAI API - AI Integration
• Anthropic Claude API - AI Integration

Getting Started 🚀

Prerequisites

• Node.js (v18 or higher)
• npm or yarn
• OpenAI API key (optional)
• Anthropic API key (optional)

Installation

1. Clone the repository:

   git clone https://github.com/perryraskin/release-notes-by-ai.git
   cd release-notes-by-ai

2. Install dependencies:

   npm install
   # or
   yarn install

3. Set up your API keys in one of two ways:

   a. Using localStorage:

   // Open your browser's developer console and run:
   localStorage.setItem("OPENAI_API_KEY", "your_openai_api_key_here");
   localStorage.setItem("ANTHROPIC_API_KEY", "your_anthropic_api_key_here");
   localStorage.setItem("GITHUB_TOKEN", "your_github_token_here");

   b. Using environment variables: Create a .env file in the root directory and add:

   VITE_OPENAI_API_KEY=your_openai_api_key_here
   VITE_ANTHROPIC_API_KEY=your_anthropic_api_key_here
   VITE_GITHUB_TOKEN=your_github_token_here

   Note: You only need to set up the API key for the service you plan to use. The application supports both OpenAI and Anthropic models.

   Note: You only need a GitHub token if you plan to generate release notes for private repositories.

4. Start the development server:

   npm run dev
   # or
   yarn dev

The application will be available at http://localhost:8080

Building for Production 🏗️

To create a production build:

npm run build

# or

yarn build

Contributing 🤝

Contributions are welcome! Feel free to:

1. Fork the repository
2. Create a new branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Commit your changes (git commit -m 'Add some amazing feature')
5. Push to the branch (git push origin feature/amazing-feature)
6. Open a Pull Request

Please make sure to update tests as appropriate and adhere to the existing coding style.

License 📄

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

Support 💪

If you find this project useful, please consider giving it a ⭐️ on GitHub!

For issues, feature requests, or questions, please use the GitHub Issues page.