Awesome Things

A comprehensive collection of awesome development tools, resources, and documentation that make development and life better. This repository serves as both a curated collection of useful resources and a practical guide for modern development workflows.

🏷️ Badges

📋 Table of Contents

🏷️ Badges
📊 Project Architecture
🔄 Development Workflow
✨ Key Features
🚀 What's Inside
🏗️ Repository Structure
🚀 Quick Start
📖 Documentation Highlights
🛠️ Technologies Covered
🎯 Use Cases
🔧 Troubleshooting
🤝 Contributing
📝 License
🙏 Acknowledgments
🔗 Links

📊 Project Architecture

flowchart TD
    A[Awesome Things Repository] --> B[Documentation]
    A --> C[Cursor IDE Configuration]
    A --> D[Development Tools]
    
    B --> B1[Comprehensive Guides]
    B --> B2[Best Practices]
    B --> B3[Workflow Documentation]
    
    C --> C1[Custom Rules]
    C --> C2[Slash Commands]
    C --> C3[MCP Integration]
    
    D --> D1[UV Python Manager]
    D --> D2[Code Quality Tools]
    D --> D3[Development Workflows]
    
    C1 --> E[Global Standards]
    C1 --> F[UV Python Rules]
    
    C2 --> G[Generate Docs]
    C2 --> H[Update Docs]
    C2 --> I[Setup Projects]
    C2 --> J[Development Workflows]
    
    C3 --> K[Ref MCP]
    C3 --> L[Exa MCP]
    
    D1 --> M[Package Management]
    D1 --> N[Project Setup]
    D1 --> O[Dependency Management]
    
    D2 --> P[Black Formatting]
    D2 --> Q[Ruff Linting]
    D2 --> R[MyPy Type Checking]
    D2 --> S[Pytest Testing]
    
    style A fill:#e1f5fe
    style B fill:#f3e5f5
    style C fill:#e8f5e8
    style D fill:#fff3e0

🔄 Development Workflow

flowchart LR
    Start([Start Development]) --> Setup[Project Setup]
    Setup --> Rules[Apply Cursor Rules]
    Rules --> Commands[Use Slash Commands]
    Commands --> Docs[Generate Documentation]
    Docs --> Quality[Code Quality Checks]
    Quality --> Deploy[Deploy/Share]
    Deploy --> End([Complete])
    
    Setup --> UV[UV Package Manager]
    UV --> Dependencies[Manage Dependencies]
    Dependencies --> Development[Active Development]
    Development --> Testing[Run Tests]
    Testing --> Quality
    
    Commands --> Generate[Generate Docs]
    Commands --> Update[Update Docs]
    Commands --> Create[Create Rules]
    Commands --> Workflow[Development Workflow]
    
    style Start fill:#4caf50
    style End fill:#f44336
    style Setup fill:#2196f3
    style Quality fill:#ff9800

✨ Key Features

🚀 Modern Development Stack

Cursor IDE Integration - AI-powered development with custom rules and commands
UV Python Package Manager - 10-100x faster than traditional tools
MCP Tool Integration - Automated research and documentation generation
GitHub Copilot Integration - Repository-specific instructions and chat modes
Comprehensive Documentation - Complete guides and best practices

📚 Documentation System

Automated Generation - AI-powered documentation creation using Ref MCP and Exa MCP
Comprehensive Guides - Step-by-step tutorials for modern development workflows
GitHub Integration - Custom instructions, chat modes, and prompts
Best Practices - Industry-standard patterns and conventions
Visual Architecture - Mermaid diagrams for clear project understanding

🛠️ Development Tools

Code Quality - Black, Ruff, MyPy, and pytest integration
Project Templates - Ready-to-use configurations for various project types
Workflow Automation - Streamlined development processes with 20+ custom commands
Team Collaboration - Shared rules and standards for consistent development
Security - Automated security auditing and secrets management

🚀 What's Inside

📚 Documentation

Core Development Guides

Cursor IDE .cursor Folder Guide - Complete guide to customising Cursor IDE with rules and commands
Cursor Commands Guide - Master your AI-powered development workflow
Cursor Commands Feature Guide - Comprehensive feature overview
UV Python Package Manager Guide - Comprehensive guide to using UV for Python development
Docker UV Guide - Docker containerisation with UV Python package manager

GitHub Integration Guides

GitHub Copilot Guide - AI-powered coding assistance
GitHub Instructions Guide - Repository custom instructions
GitHub Chatmodes Guide - Custom chat modes configuration
GitHub Prompts Guide - Prompts and custom instructions

CI/CD and Automation

GitHub Actions CI/CD Guide - Continuous integration and deployment workflows
GitHub Actions Secrets Guide - Secure secrets management
GitHub Actions Secrets Fix Summary - Security fixes and improvements
Workflow Syntax Fix Summary - Workflow syntax improvements

Quick Reference

Cursor Commands Summary - Quick reference for Cursor commands

🛠️ Cursor IDE Configuration

This repository includes a complete Cursor IDE setup with custom rules and commands:

Rules (`.cursor/rules/`)

global.mdc - Global project rules and coding standards
uv-python.mdc - UV Python package manager development standards
docker-uv-python.mdc - Docker containerisation with UV Python standards

Commands (`.cursor/commands/`)

generate-docs.md - Automatically research and generate comprehensive documentation
update-docs.md - Update existing documentation with latest information
create-rules-commands.md - Create custom Cursor rules and commands
setup-uv-project.md - Initialize new Python projects with UV
uv-development-workflow.md - Execute comprehensive UV development workflows

🏗️ Repository Structure

awesome_things/
├── docs/                                    # Comprehensive documentation
│   ├── cursor-folder-guide.md              # Cursor IDE configuration guide
│   ├── cursor-commands-guide.md            # Master Cursor commands guide
│   ├── cursor-commands-feature-guide.md    # Cursor commands feature overview
│   ├── cursor-commands-summary.md          # Quick reference guide
│   ├── uv-python-guide.md                  # UV Python package manager guide
│   ├── docker-uv-guide.md                  # Docker with UV integration
│   ├── github-copilot-guide.md             # GitHub Copilot configuration
│   ├── github-instructions-guide.md        # Repository custom instructions
│   ├── github-chatmodes-guide.md           # Custom chat modes
│   ├── github-prompts-guide.md             # Prompts and instructions
│   ├── github-actions-cicd-guide.md        # CI/CD workflows
│   ├── github-actions-secrets-guide.md     # Secrets management
│   ├── github-actions-secrets-fix-summary.md # Security fixes
│   └── workflow-syntax-fix-summary.md      # Workflow improvements
├── .cursor/                                 # Cursor IDE configuration
│   ├── rules/                               # Custom development rules
│   │   ├── global.mdc                      # Global project standards
│   │   ├── uv-python.mdc                   # UV Python development rules
│   │   └── docker-uv-python.mdc            # Docker with UV standards
│   └── commands/                            # Custom slash commands
│       ├── README.md                       # Commands overview
│       ├── update-readme.md                # README update command
│       ├── generate-docs.md                # Documentation generation
│       ├── update-docs.md                  # Documentation updates
│       ├── create-rules-commands.md        # Rule and command creation
│       ├── setup-uv-project.md             # Project initialization
│       ├── setup-docker-uv-project.md      # Docker project setup
│       ├── uv-development-workflow.md      # Development workflows
│       ├── docker-uv-workflow.md           # Docker workflows
│       ├── code-review.md                  # Code review automation
│       ├── write-tests.md                  # Test generation
│       ├── fix-bugs.md                     # Bug fixing
│       ├── refactor-code.md                # Code refactoring
│       ├── setup-new-feature.md            # Feature implementation
│       ├── optimise-performance.md         # Performance optimization
│       ├── security-audit.md               # Security auditing
│       ├── add-documentation.md            # Documentation addition
│       ├── create-pr.md                    # Pull request creation
│       ├── debug-issue.md                  # Issue debugging
│       └── onboard-developer.md            # Developer onboarding
├── .gitignore                              # Git ignore configuration
└── README.md                               # This file

🚀 Quick Start

Prerequisites

Before you begin, ensure you have the following installed:

Cursor IDE - Download from cursor.com
UV Python Package Manager - Install using the command below
Git - For version control

Installation

1. Install UV Python Package Manager

# Install UV (works on macOS, Linux, and Windows)
curl -LsSf https://astral.sh/uv/install.sh | sh

# Restart your terminal or run:
source ~/.bashrc  # or ~/.zshrc

2. Clone This Repository

git clone https://github.com/CodeWithBehnam/awesome_things.git
cd awesome_things

3. Configure GitHub Copilot (Optional)

# Create repository custom instructions
mkdir -p .github
cat > .github/copilot-instructions.md << 'EOF'
# Repository Custom Instructions

This repository uses UV Python package manager and follows modern development practices.

## Key Technologies
- UV Python package manager
- Docker containerisation
- Cursor IDE with custom rules
- GitHub Actions for CI/CD

## Coding Standards
- Use UV for all Python package management
- Follow PEP 8 with Black formatting
- Use type hints with MyPy
- Write comprehensive tests with pytest
EOF

# Create custom chat modes
mkdir -p .github/chatmodes
cat > .github/chatmodes/security-reviewer.md << 'EOF'
# Security Reviewer Chat Mode

## Persona
You are a security expert reviewing code for vulnerabilities and best practices.

## Tools
- Security analysis tools
- Code review capabilities
- Vulnerability scanning

## Instructions
- Focus on security implications
- Check for common vulnerabilities
- Recommend security best practices
- Review secrets management
EOF

Using Cursor IDE Commands

The repository includes custom slash commands for streamlined development:

📚 Documentation Commands

# Generate comprehensive documentation
/generate-docs Create comprehensive documentation about [topic]

# Update existing documentation
/update-docs Update the existing documentation with latest information

⚙️ Configuration Commands

# Create custom rules and commands
/create-rules-commands Create rules and commands for [technology/framework]

# Setup new UV Python project
/setup-uv-project Create a new FastAPI web application with testing tools

🔄 Development Workflow Commands

# Run comprehensive development tasks
/uv-development-workflow Run daily development tasks including code quality checks

Using UV Python Package Manager

Create a New Project

# Initialize a new project
uv init my-awesome-project
cd my-awesome-project

# Pin Python version
uv python pin 3.12

# Add dependencies
uv add requests flask sqlalchemy
uv add --dev pytest black ruff mypy

Development Workflow

# Run your application
uv run python main.py

# Run tests
uv run pytest

# Format code
uv run black .

# Lint code
uv run ruff check .

# Type checking
uv run mypy .

Package Management

# Add new dependencies
uv add package-name

# Add development dependencies
uv add --dev package-name

# Remove packages
uv remove package-name

# Sync dependencies
uv sync

📖 Documentation Highlights

Cursor IDE Guide

Complete .cursor folder structure with rules and commands
MCP tool integration for automated research and documentation
Best practices for team collaboration and code quality
Custom workflows for streamlined development

UV Python Guide

Modern package management with 10-100x speed improvements
Comprehensive project setup with best practices
Development workflows for all project types
Migration guides from pip, Poetry, and Conda

🛠️ Technologies Covered

Cursor IDE - AI-powered code editor with custom rules and commands
UV Python - Modern Python package manager written in Rust
MCP Tools - Ref MCP and Exa MCP for automated research
GitHub Copilot - AI-powered coding assistance with custom instructions
GitHub Actions - CI/CD workflows with secure secrets management
Docker - Containerisation with UV Python integration
Python Development - Web apps, APIs, data science, CLI tools
Code Quality - Black, Ruff, MyPy, pytest, pre-commit hooks

🎯 Use Cases

For Developers

Streamline development workflows with custom Cursor commands
Modernise Python development with UV package manager
Automate documentation generation and updates
Standardise team practices with shared rules and commands

For Teams

Consistent development environments across team members
Automated code quality checks and standards
GitHub Copilot customisation with repository-specific instructions
Custom chat modes for different development roles
Comprehensive documentation for onboarding and reference
Best practices for modern Python development
Secure CI/CD with proper secrets management

For Projects

Quick project setup with UV and Cursor integration
Comprehensive documentation generation and maintenance
Quality assurance with automated checks and standards
Scalable development workflows for any project size

🔧 Troubleshooting

Common Issues

UV Installation Problems

# If UV installation fails, try:
curl -LsSf https://astral.sh/uv/install.sh | sh --force

# For Windows users, use PowerShell:
powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

Cursor IDE Commands Not Working

Ensure you're in a project with .cursor folder
Check that commands are properly formatted
Restart Cursor IDE if commands don't appear

Python Environment Issues

# Reset UV environment
uv sync --reinstall

# Clear UV cache
uv cache clean

GitHub Copilot Issues

Custom Instructions Not Working
- Ensure .github/copilot-instructions.md exists
- Check file permissions and syntax
- Restart VS Code/Cursor IDE
Chat Modes Not Available
- Verify VS Code version (v1.101+)
- Check .github/chatmodes/ directory structure
- Ensure proper YAML syntax in chat mode files
Repository Context Issues
- Clear Copilot cache: Ctrl/Cmd + Shift + P → "GitHub Copilot: Clear Cache"
- Restart the IDE
- Check repository permissions

Getting Help

Documentation Issues: Check the relevant guide in the docs/ folder
UV Problems: Visit UV Documentation
Cursor IDE Issues: Check Cursor Documentation

🤝 Contributing

We welcome contributions to make this collection even more awesome! Here's how you can contribute:

🎯 How to Contribute

Adding New Content

Fork the repository and create a feature branch
Add your awesome discovery to the appropriate section
Update documentation if needed
Test your changes thoroughly
Submit a pull request with a clear description

Improving Existing Content

Identify areas for improvement in documentation or rules
Make your changes following the established patterns
Test your changes to ensure they work correctly
Update related documentation as needed
Submit a pull request with details about your improvements

Creating New Rules and Commands

Follow the established patterns in existing rules and commands
Include comprehensive documentation and examples
Test thoroughly to ensure they work as expected
Add to the appropriate guide in the docs/ folder
Submit a pull request with your new additions

📋 Contribution Guidelines

Code Quality: Follow the established coding standards
Documentation: Update relevant documentation for any changes
Testing: Ensure all changes work as expected
Commit Messages: Use clear, descriptive commit messages
Pull Requests: Provide detailed descriptions of changes

🏷️ Issue Labels

bug - Something isn't working
enhancement - New feature or request
documentation - Improvements or additions to documentation
help wanted - Extra attention is needed
good first issue - Good for newcomers

📝 License

This project is open source and available under the MIT License.

🙏 Acknowledgments

Cursor IDE - For providing an amazing AI-powered development environment
UV Python - For revolutionizing Python package management
Astral - For creating incredible Rust-based Python tools
Community - For sharing awesome tools and resources

🔗 Links

Repository: https://github.com/CodeWithBehnam/awesome_things
Cursor IDE: https://cursor.com
UV Python: https://docs.astral.sh/uv/
MCP Tools: https://docs.ref.tools/
GitHub Copilot: https://docs.github.com/en/copilot/
GitHub Actions: https://docs.github.com/en/actions

FilesExpand file tree

README.md

Latest commit

History