Skip to content

freyjay/ai-project-setup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

2 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿš€ AI-Powered Project Setup Automation

Transform your development workflow with automated project creation and AI-driven blueprint discovery.

This repository provides a complete solution for automated project setup with integrated Claude AI workflow that ensures every project starts with proper planning and vision.

โœจ Features

  • ๐ŸŽฏ Automated Project Creation - One-click project setup with templates
  • ๐Ÿค– AI Blueprint Discovery - Claude automatically guides project planning
  • ๐ŸŽจ Perfect UX - Instant focus, clean interface, seamless workflow
  • ๐Ÿ”’ Security-First - No unnecessary permissions, transparent operation
  • ๐Ÿ“ Template System - Reusable project structures with best practices
  • โšก Developer Optimized - Built for Claude Code + Cursor integration

๐ŸŽฅ Demo

Coming soon: YouTube walkthrough and implementation guide

๐Ÿ“‹ Prerequisites

Required Tools

  • macOS (tested on macOS 14+)
  • Python 3.8+ (usually pre-installed on macOS)
  • Git (for version control)
  • Terminal or iTerm2

Recommended AI Tools

  • Claude Code - AI coding assistant
  • Cursor - AI-powered code editor
  • VS Code or other preferred editor (fallback)

Development Environment

  • Homebrew (recommended for package management)
  • Node.js & npm (for web projects)
  • Your preferred development stack

๐Ÿš€ Quick Start

1. Download the Application

# Clone this repository
git clone https://github.com/freyjay/ai-project-setup.git
cd ai-project-setup

# Copy the app to your desired location
cp -r app/* ~/Developer/project-setup-automation/

2. Setup Git Configuration

Create your Git accounts configuration:

cd ~/Developer/project-setup-automation
# Configure your Git accounts (see Configuration section below)

3. Launch the App

cd ~/Developer/project-setup-automation
python3 project-setup-app.py

4. Create Your First Project

  1. Enter project name (cursor automatically focuses here)
  2. Select Git account from dropdown
  3. Click "Create Project"
  4. Success! Project created with AI workflow integrated

โš™๏ธ Configuration

Git Accounts Setup

The app uses git-accounts.json for Git configuration:

{
  "freyjay": {
    "name": "freyjay",
    "email": "francis@freyjay.dev",
    "ssh_host": "github-personal",
    "ssh_key": "~/.ssh/id_rsa_personal"
  }
}

SSH Configuration

Add to your ~/.ssh/config:

Host github-personal
  HostName github.com
  User git
  IdentityFile ~/.ssh/id_rsa_personal

Project Template Location

Default template location: ~/Developer/project-template-minimal

๐ŸŽฏ How It Works

The AI Blueprint Workflow

  1. Project Creation - App creates project from template
  2. Claude Integration - AI reads CLAUDE.md workflow instructions
  3. Plan Mode Activation - Claude automatically enters blueprint discovery
  4. 5 Key Questions - Systematic project vision development:
    • What type of application?
    • Core features needed?
    • Target users and problems?
    • Technical architecture?
    • Scope and timeline?
  5. Documentation - Complete blueprint.md created
  6. Development - Only proceeds after vision approval

Project Structure Created

your-new-project/
โ”œโ”€โ”€ CLAUDE.md              # AI workflow instructions
โ”œโ”€โ”€ WORKFLOW.md            # Complete process documentation
โ”œโ”€โ”€ README.md              # Project overview
โ”œโ”€โ”€ tasks/
โ”‚   โ”œโ”€โ”€ todo.md           # Current work tracking
โ”‚   โ””โ”€โ”€ blueprint.md      # Project vision (AI creates this)
โ”œโ”€โ”€ config/
โ”‚   โ”œโ”€โ”€ commands.md       # Development commands
โ”‚   โ”œโ”€โ”€ standards.md      # Coding standards
โ”‚   โ”œโ”€โ”€ stack.md          # Tech stack info
โ”‚   โ””โ”€โ”€ environment.md    # Setup requirements
โ””โ”€โ”€ src/                  # Your code goes here

๐Ÿ’ก Usage Tips & Tricks

๐ŸŽฏ Best Practices

  1. Always Complete Blueprint First

    • Don't skip the AI discovery process
    • Answer all 5 key questions thoroughly
    • Get stakeholder approval before coding
  2. Use the Workflow Commands

    # Re-enter blueprint mode anytime
    "lets go back to plan mode and deeply understand what we are building"
    
    # Create project blueprint
    "create a blueprint for our project"
    
    # Solidify vision
    "solidify our project vision"
  3. Template Customization

    • Modify project-template-minimal for your needs
    • Add your preferred tools and configurations
    • Update placeholder values for your workflow

โšก Power User Features

  • Batch Project Creation - Create multiple related projects
  • Template Variants - Different templates for different project types
  • Integration Hooks - Extend with additional automation
  • Custom Commands - Add your development workflow commands

๐Ÿ” Validation Commands

# Check if blueprint is complete
grep "TO BE DETERMINED" tasks/blueprint.md

# Verify all discovery questions answered
grep "\[ \]" tasks/blueprint.md

# Review project status
cat tasks/todo.md

๐Ÿ› ๏ธ Customization

Modifying the Template

  1. Edit Template Files

    cd ~/Developer/project-template-minimal
    # Modify files to match your preferences
  2. Update Placeholders

    • [PROJECT_NAME] - Replaced with actual project name
    • [PROJECT_DESCRIPTION] - Replaced with description
    • [REPOSITORY_URL] - Replaced with Git URL
  3. Add Your Tools

    • Package.json configurations
    • Docker setups
    • CI/CD configurations
    • Testing frameworks

App Customization

  • Window Size: Modify geometry in project-setup-app.py
  • Default Paths: Update developer_dir and template_dir
  • Git Integration: Customize Git initialization process
  • UI Elements: Modify tkinter interface elements

๐Ÿ”ง Troubleshooting

Common Issues

App doesn't focus on project name field

  • Solution: Window focus fix is built-in (auto-retry mechanism)

Git authentication fails

  • Check SSH key configuration
  • Verify Git account settings in json file
  • Test SSH connection: ssh -T git@github.com

Template not found

  • Verify template directory exists
  • Check file permissions
  • Ensure all template files are present

Claude doesn't enter plan mode

  • Check CLAUDE.md file exists in created project
  • Verify blueprint workflow section is present
  • Restart Claude Code session

Advanced Troubleshooting

Permission Issues

# Fix file permissions
chmod +x project-setup-app.py
chmod -R 755 project-template-minimal/

Python Issues

# Check Python version
python3 --version

# Install/update tkinter if needed
# (Usually included with Python on macOS)

๐ŸŽฌ Video Tutorial

Coming in v2: Complete YouTube walkthrough covering:

  • Installation and setup
  • First project creation
  • AI workflow demonstration
  • Advanced customization
  • Tips and best practices

๐Ÿ”— Complementary Tools

This project is part of a dual-tool development ecosystem:

๐Ÿ› ๏ธ Complementary Project: git-setup-toolkit

Tool Primary Use Reliability Speed Recovery
ai-project-setup GUI automation, full templates High (GUI-based) Medium Not designed for
git-setup-toolkit CLI fallback, core git setup ~100% (hybrid approach) Fast Excellent

When to Use Each:

  • ai-project-setup - Primary choice for comprehensive new projects with full templates and AI workflow integration
  • git-setup-toolkit - Manual setup, quick prototypes, or when ai-project-setup isn't available
  • Recovery scenarios - Use git-setup-toolkit to fix broken project configurations

Both tools create identical git configurations and work seamlessly together in your development workflow.

๐Ÿ”ฎ Roadmap (v2 Features)

  • ๐ŸŽจ Enhanced UI - Modern interface with dark mode
  • ๐Ÿ“Š Project Analytics - Track project creation and success metrics
  • ๐Ÿ”„ Template Manager - Easy template switching and management
  • ๐ŸŒ Multi-Platform - Windows and Linux support
  • ๐Ÿ”— IDE Integration - Direct integration with more editors
  • ๐Ÿ“ฑ Mobile Companion - Project tracking on mobile
  • ๐Ÿค– Advanced AI Features - More intelligent project suggestions

๐Ÿค Contributing

We welcome contributions! Please see CONTRIBUTING.md for guidelines.

Development Setup

git clone https://github.com/freyjay/ai-project-setup.git
cd ai-project-setup
# Follow installation instructions above

๐Ÿ“ License

MIT License - see LICENSE for details.

๐Ÿ™ Acknowledgments

  • Claude AI - For the brilliant blueprint workflow concept
  • Cursor - For AI-powered development experience
  • Anthropic - For providing Claude capabilities
  • Open Source Community - For inspiration and best practices

๐Ÿ“ž Support


Built with โค๏ธ for developers who value both automation and thoughtful planning.

โญ Star this repo if it helps your development workflow!

About

๐Ÿš€ AI-Powered Project Setup Automation - Transform your development workflow with automated project creation

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors