Skip to content

samphif/AI-Tools

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

AI Tools Repository

Purpose: A comprehensive collection of AI-assisted development tools, templates, and frameworks to ensure consistent, high-quality project delivery with full context, testing, and documentation.

🎯 Repository Goals

This repository provides a systematic framework for AI-assisted development that ensures:

  • Consistent Process: Every requirement goes through high-level solution design, development, testing, and documentation
  • Full Context: AI agents have complete understanding of requirements and project constraints
  • Quality Assurance: Built-in testing frameworks and validation processes
  • Documentation Standards: Consistent technical, user, and project documentation

📁 Repository Structure

AI Tools/
├── ai_docs/                    # AI Documentation & Templates
│   ├── references/            # Reference materials and guides
│   ├── tasks/                 # Task-specific documentation
│   └── templates/             # Reusable templates
│       ├── task_template.md   # Main task planning template
│       ├── bugfix.md          # Bug fix specific template
│       ├── cleanup.md         # Code cleanup template
│       ├── code_review.md     # Code review template
│       ├── gcp_debugging_template.md
│       ├── gcp_setup_template.md
│       ├── generate_diagram.md
│       ├── git_workflow_commit.md
│       ├── improve_ui.md
│       ├── python_task_template.md
│       ├── rpc_function_template.md
│       ├── shipkit_update_workflow.md
│       ├── stripe_setup.md
│       ├── supabase_storage_setup.md
│       ├── supabase_user_trigger_setup.md
│       └── drizzle_down_migration.md
├── apps/                      # Example applications and tools
├── frameworks/                # Development frameworks
├── testing/                   # Testing utilities and frameworks
└── docs/                      # Project documentation

🚀 Quick Start

Workspace Integration (Recommended)

# 1. Add AI Tools to your Cursor workspace
git clone https://github.com/your-username/ai-tools.git

# 2. In your project directory, run the setup script
../ai-tools/scripts/setup-project.sh

# 3. Create your first task
cp ../ai-tools/ai_docs/templates/task_template.md ai-docs/tasks/my-first-feature.md

Manual Setup

  1. Choose Your Template: Select the appropriate template from ai_docs/templates/
  2. Fill Out Requirements: Use the structured template to define your project needs
  3. AI Integration: Provide the template to your AI agent for consistent execution
  4. Track Progress: Monitor implementation through the built-in tracking system

📋 Core Templates

Main Templates

  • task_template.md - Comprehensive project planning and execution framework
  • bugfix.md - Systematic bug identification and resolution
  • code_review.md - Structured code review process
  • improve_ui.md - UI/UX improvement framework

Technology-Specific Templates

  • python_task_template.md - Python-specific development tasks
  • stripe_setup.md - Payment integration setup
  • supabase_storage_setup.md - Database and storage configuration
  • gcp_setup_template.md - Google Cloud Platform setup

Workflow Templates

  • git_workflow_commit.md - Git workflow and commit standards
  • shipkit_update_workflow.md - Release and deployment workflows

🔧 Usage Guidelines

For AI Agents

  1. Always start with the appropriate template
  2. Follow the structured sections systematically
  3. Update progress tracking in real-time
  4. Provide clear documentation for all changes

For Developers

  1. Use templates to ensure consistency across projects
  2. Reference templates directly from the AI Tools workspace
  3. Maintain the documentation standards
  4. Leverage the testing frameworks provided

Workspace Integration

  1. Add AI Tools as a separate folder in your Cursor workspace
  2. Run the setup script in each project to create the structure
  3. Reference templates directly without copying
  4. Update templates centrally for all projects

📚 Documentation Standards

Every project should include:

  • Technical Requirements Document - Detailed technical specifications
  • User Requirements Document - User stories and acceptance criteria
  • Project Plan Document - Timeline, milestones, and resource allocation

🤝 Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Add your templates or improvements
  4. Submit a pull request with detailed documentation

📄 License

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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages