appclean 1.8.0

package/GITHUB_OPTIMIZATION.md

@@ -0,0 +1,383 @@
+# GitHub Repository Optimization Guide
+
+## Current Status ✅
+
+### Topics (13 added)
+```
+app-management, cleanup, cli, cross-platform, homebrew, linux, macos, npm,
+package-manager, system-cleanup, uninstall, uninstaller, windows
+```
+
+### About Section
+- ✅ Description: Comprehensive problem/solution statement
+- ✅ Website: https://github.com/praveenkay/AppClean
+- ✅ All 13 topics added
+
+## GitHub Discussions Setup
+
+### Enable Discussions
+1. Go to Settings → General
+2. Scroll to "Features"
+3. Check "Discussions" checkbox
+4. Save
+
+### Create Discussion Categories
+
+#### 1. Announcements
+- **Description**: Latest releases and feature announcements
+- **Welcome message**: "Follow releases for major updates and new features"
+- **Pin important posts**
+
+#### 2. Q&A
+- **Description**: Ask questions and get help
+- **Welcome message**: "Got a question? Ask here! Use --help flag first"
+- **Moderator: Enable answer marking**
+
+#### 3. Ideas
+- **Description**: Suggest new features
+- **Welcome message**: "Have an idea? Suggest it here"
+- **Vote on ideas**
+
+#### 4. Show & Tell
+- **Description**: Share how you use AppClean
+- **Welcome message**: "Show your AppClean workflows and scripts"
+
+#### 5. Troubleshooting
+- **Description**: Debug issues and problems
+- **Welcome message**: "Running into issues? Describe your problem with os/version"
+
+### Pin Discussion Posts
+```
+"Which package managers do you use most?" - Get feedback
+"AppClean v1.8.0 released" - Announcement
+"Share your use cases" - Community engagement
+```
+
+## Social Preview Image
+
+### Current Status
+- No custom social preview image set
+
+### Create OG Image
+Dimensions: **1200 x 630 pixels**
+
+Include:
+- AppClean logo (large)
+- "AppClean: Uninstall Apps Properly"
+- "Remove all artifacts from npm, brew, apt, and more"
+- GitHub logo
+- Color: Blue/green gradient (#667eea to #764ba2)
+
+### Set OG Image
+1. Save as `og-image.png` in repo root
+2. GitHub automatically uses it for social preview
+
+## GitHub Pages / Website (Optional)
+
+### Option 1: GitHub Pages Site
+```bash
+# Create docs/ folder
+mkdir -p docs
+
+# Add index.html with landing page
+# Add features.html
+# Add installation.html
+
+# Enable in Settings -> Pages -> Source: /docs folder
+```
+
+### Option 2: Dedicated Website
+```
+appclean.dev (register domain)
+Deploy Next.js or static site
+Auto-sync docs from GitHub README
+```
+
+## Release Optimization
+
+### Current v1.8.0 Release
+- ✅ Release notes uploaded
+- ✅ All 7 new versions (v1.2.0-v1.8.0) released
+
+### Next Release Checklist
+- [ ] Generate release notes automatically
+- [ ] Create release assets (binaries for macOS/Linux/Windows)
+- [ ] Tag all releases consistently (v1.x.x format)
+- [ ] Mention in GitHub Activity Feed
+
+### Release Template
+
+```markdown
+# v{version} - {Feature}
+
+## What's New
+[Brief 2-3 sentence summary]
+
+## Features
+[List of features]
+
+## Installation
+\`\`\`bash
+npm install -g appclean@{version}
+\`\`\`
+
+## Changes
+[Detailed changelog]
+
+## Contributors
+[Thank community members]
+
+## What's Next
+[Hint at future features]
+```
+
+## GitHub Stars Strategy
+
+### Current Status
+- ⭐ Repository is public and discoverable
+- ✅ All topics optimized
+- ✅ Description comprehensive
+
+### To Increase Stars
+
+1. **Awesome Lists**
+   - Add to: awesome-npm, awesome-cli-apps, awesome-node
+   - Search "awesome-" on GitHub and submit PR
+
+2. **GitHub Trending**
+   - Happens automatically with high activity
+   - Create releases with clear, interesting titles
+   - Engage with issues and PRs
+
+3. **Social Proof**
+   - Display star count prominently
+   - Create tweets when milestones reached (100 stars, 500, 1k)
+
+4. **Quality Content**
+   - Comprehensive README ✅
+   - Good documentation ✅
+   - Active maintenance
+   - Community engagement
+
+## Repository Health
+
+### Current Badges
+- ✅ Version badge
+- ✅ License badge
+- ✅ Platform badge
+- ✅ npm downloads badge
+
+### Add Health Badges
+
+```markdown
+<!-- GitHub Actions / CI Status -->
+[![Build Status](https://github.com/praveenkay/AppClean/workflows/CI/badge.svg)](https://github.com/praveenkay/AppClean/actions)
+
+<!-- Code Quality -->
+[![Code Climate](https://api.codeclimate.com/v1/badges/...)](https://codeclimate.com/...)
+
+<!-- npm Package -->
+[![npm](https://img.shields.io/npm/v/appclean.svg)](https://www.npmjs.com/package/appclean)
+```
+
+## GitHub Collaborators & Permissions
+
+### Recommended Structure
+- **Owner**: Praveen Kothapally
+- **Maintainer**: You (for issue triage)
+- **Contributors**: Community members (who earn it)
+
+### Guidelines for Contributors
+1. Fork repository
+2. Create feature branch
+3. Submit pull request
+4. Code review process
+5. Merge and celebrate
+
+## GitHub Actions / CI/CD
+
+### Set Up Automated Testing
+```yaml
+# .github/workflows/test.yml
+name: Tests
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+      - run: npm install
+      - run: npm test
+```
+
+### Automated Publishing
+```yaml
+# Publish to npm on release
+- run: npm publish --access public
+```
+
+## GitHub Security
+
+### Enable Security Features
+1. **Branch Protection**
+   - Require pull request reviews
+   - Require status checks to pass
+   - Dismiss stale reviews
+
+2. **Dependabot**
+   - Enable automated dependency updates
+   - Set to weekly or monthly
+
+3. **Security Scanning**
+   - Enable GitHub's security scanning
+   - Review security advisories
+
+## GitHub Profile Optimization
+
+### Your Profile
+- Set profile picture
+- Add bio: "Creator of AppClean"
+- Link to website/Twitter
+- Pin AppClean repository
+
+### Highlight AppClean
+- Pin on your GitHub profile
+- Featured prominently
+- Link to demo/documentation
+
+## Community Building
+
+### Create CONTRIBUTING.md
+```markdown
+# Contributing to AppClean
+
+## Getting Started
+1. Fork the repo
+2. Clone your fork
+3. npm install
+4. npm run dev
+
+## Making Changes
+- Create feature branch
+- Follow existing code style
+- Add tests
+- Update documentation
+
+## Submitting PRs
+- Link to issue
+- Describe changes clearly
+- Reference v1.x.0 compatibility
+
+## Report Issues
+- Use bug report template
+- Include OS and Node version
+- Provide reproduction steps
+```
+
+### Create CODE_OF_CONDUCT.md
+```markdown
+# Code of Conduct
+
+## Our Pledge
+We are committed to providing a welcoming and inspiring community...
+
+## Our Standards
+- Respectful language
+- Constructive feedback
+- Inclusivity
+- No harassment
+
+## Enforcement
+- Issues will be reviewed
+- Serious violations result in removal
+```
+
+### Create SECURITY.md
+```markdown
+# Security Policy
+
+## Reporting Security Issues
+Please email security@appclean.dev (or similar) instead of public issues.
+
+## Supported Versions
+- v1.8.0: Current (security updates)
+- v1.7.0 and below: Best effort support
+
+## Security Updates
+Follow semantic versioning (patch versions for security)
+```
+
+## GitHub Wiki (Optional)
+
+Create wiki pages for:
+- Installation guide per OS
+- Troubleshooting
+- Advanced usage
+- Plugin development
+- FAQ
+
+## Metrics to Track
+
+```
+Daily:
+- New issues
+- Discussion posts
+- Pull requests
+
+Weekly:
+- Stars gained
+- npm downloads
+- GitHub traffic
+
+Monthly:
+- Community contributors
+- Feature requests received
+- Bugs reported
+- Resolution rate
+```
+
+## Optimization Checklist
+
+### Immediate (Week 1)
+- [x] Add topics (13 total)
+- [x] Update About section
+- [ ] Enable Discussions
+- [ ] Create discussion categories
+- [ ] Post initial discussion (Announcement)
+
+### Short-term (Month 1)
+- [ ] Create social preview image
+- [ ] Add CONTRIBUTING.md
+- [ ] Add CODE_OF_CONDUCT.md
+- [ ] Add SECURITY.md
+- [ ] Set up GitHub Actions CI/CD
+- [ ] Pin discussions
+
+### Medium-term (Months 2-3)
+- [ ] Set up GitHub Pages
+- [ ] Create awesome-list submissions
+- [ ] Reach 100+ stars
+- [ ] Community contribution guidelines
+- [ ] Add CI/CD badges
+
+### Long-term (6+ months)
+- [ ] 1k+ stars
+- [ ] Regular contributors
+- [ ] Community plugins
+- [ ] Dedicated website
+- [ ] Sponsorship/funding
+
+## Links for Submissions
+
+### Awesome Lists
+- https://github.com/agarrharr/awesome-cli-apps
+- https://github.com/sindresorhus/awesome-nodejs
+- https://github.com/awesome-sh/awesome-shell
+- https://github.com/k4m4/terminals-are-sexy
+
+### Developer Communities
+- Show HN: https://news.ycombinator.com/
+- Product Hunt: https://www.producthunt.com/
+- Dev.to: https://dev.to/
+- Reddit r/commandline, r/linux, r/node, r/opensource

package/INDEX.md

@@ -0,0 +1,165 @@
+# 📑 AppClean Documentation Index
+
+Welcome to AppClean! This index helps you navigate all documentation and resources.
+
+## 🚀 Getting Started (Start Here!)
+
+### For New Users
+1. **[QUICKSTART.md](QUICKSTART.md)** - Quick start guide and 3-step deployment
+2. **[SETUP_GITHUB.md](SETUP_GITHUB.md)** - Detailed GitHub & npm setup instructions
+3. **[README.md](README.md)** - Full user documentation with examples
+
+### For Developers
+1. **[CONTRIBUTING.md](CONTRIBUTING.md)** - Developer guidelines and workflow
+2. **[DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md)** - Full deployment checklist
+3. **[APPCLEAN_SUMMARY.md](APPCLEAN_SUMMARY.md)** - Complete technical summary
+
+## 📚 Documentation by Purpose
+
+### Installation & Setup
+| File | Purpose |
+|------|---------|
+| [QUICKSTART.md](QUICKSTART.md) | Quick start overview |
+| [SETUP_GITHUB.md](SETUP_GITHUB.md) | GitHub & npm deployment |
+| [setup-github.sh](setup-github.sh) | Automated setup script |
+
+### User Documentation
+| File | Purpose |
+|------|---------|
+| [README.md](README.md) | Features, installation, usage, examples |
+| [PROJECT_SUMMARY.txt](PROJECT_SUMMARY.txt) | Project overview |
+| [APPCLEAN_SUMMARY.md](APPCLEAN_SUMMARY.md) | Detailed summary |
+
+### Developer Resources
+| File | Purpose |
+|------|---------|
+| [CONTRIBUTING.md](CONTRIBUTING.md) | How to contribute |
+| [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md) | Deployment steps & checklist |
+| [CHANGELOG.md](CHANGELOG.md) | Version history & roadmap |
+
+### Code & Configuration
+| File | Purpose |
+|------|---------|
+| [package.json](package.json) | Project metadata & dependencies |
+| [tsconfig.json](tsconfig.json) | TypeScript configuration |
+| [jest.config.js](jest.config.js) | Test configuration |
+| [.gitignore](.gitignore) | Git ignore rules |
+
+### GitHub Actions
+| File | Purpose |
+|------|---------|
+| [.github/workflows/test.yml](.github/workflows/test.yml) | Automated testing |
+| [.github/workflows/publish.yml](.github/workflows/publish.yml) | npm publishing |
+
+### License
+| File | Purpose |
+|------|---------|
+| [LICENSE](LICENSE) | MIT License |
+
+## 🔍 Quick Navigation
+
+### I want to...
+
+**Deploy to GitHub**
+→ Read [SETUP_GITHUB.md](SETUP_GITHUB.md)
+
+**Publish to npm**
+→ Read [SETUP_GITHUB.md](SETUP_GITHUB.md) (Section: "Setup npm Publishing")
+
+**Contribute code**
+→ Read [CONTRIBUTING.md](CONTRIBUTING.md)
+
+**Understand the project**
+→ Read [README.md](README.md) then [APPCLEAN_SUMMARY.md](APPCLEAN_SUMMARY.md)
+
+**Get started quickly**
+→ Read [QUICKSTART.md](QUICKSTART.md)
+
+**Set up development environment**
+→ Read [CONTRIBUTING.md](CONTRIBUTING.md) (Section: "Development Setup")
+
+## 📊 Project Structure
+
+```
+appclean/
+├── src/                          # Source code (13 files)
+│   ├── index.ts                 # Main CLI entry point
+│   ├── core/
+│   │   ├── detector.ts          # App detection engine
+│   │   └── remover.ts           # Safe removal engine
+│   ├── managers/
+│   │   ├── npmManager.ts        # npm/yarn/pnpm
+│   │   ├── brewManager.ts       # Homebrew
+│   │   ├── linuxManager.ts      # apt/yum/dnf
+│   │   └── customManager.ts     # Custom installers
+│   ├── ui/
+│   │   ├── menu.ts              # Interactive menus
+│   │   └── prompts.ts           # User prompts
+│   ├── types/
+│   │   └── index.ts             # TypeScript types
+│   └── utils/
+│       ├── platform.ts          # Platform detection
+│       ├── filesystem.ts        # File operations
+│       └── logger.ts            # Logging
+├── .github/workflows/           # CI/CD workflows
+├── Configuration files          # 4 config files
+├── Documentation files          # 8+ guides
+└── LICENSE                      # MIT License
+```
+
+## 🎯 Deployment Checklist
+
+- [ ] Read [QUICKSTART.md](QUICKSTART.md)
+- [ ] Review [SETUP_GITHUB.md](SETUP_GITHUB.md)
+- [ ] Create GitHub repository
+- [ ] Update package.json with your info
+- [ ] Push code to GitHub
+- [ ] Create npm account
+- [ ] Publish to npm registry
+- [ ] Update GitHub repository topics
+- [ ] Add GitHub Actions secret (NPM_TOKEN)
+
+See [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md) for detailed checklist.
+
+## 📖 Recommended Reading Order
+
+1. **First Time?** → [QUICKSTART.md](QUICKSTART.md)
+2. **Ready to Deploy?** → [SETUP_GITHUB.md](SETUP_GITHUB.md)
+3. **Want to Understand More?** → [README.md](README.md)
+4. **Contributing Code?** → [CONTRIBUTING.md](CONTRIBUTING.md)
+5. **Need Details?** → [APPCLEAN_SUMMARY.md](APPCLEAN_SUMMARY.md)
+6. **Managing Project?** → [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md)
+
+## 🔗 External Links
+
+- **GitHub**: https://github.com/new (Create repository)
+- **npm**: https://www.npmjs.com/signup (Create account)
+- **TypeScript**: https://www.typescriptlang.org/docs/
+- **Node.js**: https://nodejs.org/
+
+## 📞 Support & Questions
+
+- **Bug Reports**: GitHub Issues
+- **Questions**: GitHub Discussions
+- **Documentation**: Check files in this directory
+- **Help**: See [CONTRIBUTING.md](CONTRIBUTING.md) for development help
+
+## ✨ Key Features
+
+🔍 **Smart Detection** - Finds apps from 8+ installation methods
+📊 **Deep Analysis** - Locates all related files and artifacts
+🛡️ **Safe Removal** - Dry-run preview and backup support
+🎨 **Beautiful UI** - Interactive menus with colors and animations
+🚀 **Cross-Platform** - Works on macOS, Linux, Windows
+
+## 🌟 You're All Set!
+
+Your AppClean project is production-ready.
+
+**Next Step:** Open [SETUP_GITHUB.md](SETUP_GITHUB.md) to begin deployment!
+
+---
+
+**Last Updated:** 2024-01-20
+**License:** MIT
+**Status:** ✅ Ready for Production

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Praveen Kothapally
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.