Skip to content

ESSENTIAL_FILES_ONLY.md

Latest commit

 

History

History
154 lines (136 loc) · 4.08 KB

ESSENTIAL_FILES_ONLY.md

File metadata and controls

154 lines (136 loc) · 4.08 KB

Essential Files for GitHub Repository

✅ Files to KEEP (Essential Application Files)

Core Application

  • package.json - Dependencies
  • package-lock.json - Lock file
  • vite.config.ts - Build configuration
  • tsconfig.json - TypeScript config
  • tsconfig.node.json - Node TypeScript config
  • tailwind.config.js - Tailwind CSS config
  • postcss.config.js - PostCSS config
  • index.html - Main HTML file

Source Code

  • src/ - All source files (keep entire directory)
  • public/ - Public assets (keep entire directory)

Essential Documentation

  • README.md - Main documentation
  • LICENSE - License file

Configuration

  • .gitignore - Git ignore rules
  • netlify.toml - Netlify config (if using)
  • vercel.json - Vercel config (if using)
  • .github/workflows/ - GitHub Actions (if exists)

❌ Files to REMOVE (Before Committing)

Build Artifacts

  • dist/ - Build output (regenerated on build)
  • node_modules/ - Dependencies (installed via npm)

Temporary/Helper Files

  • *.bat - All batch files
  • *.ps1 - All PowerShell scripts
  • *.txt - All text files (except README.txt if needed)
  • *.html - Temporary HTML files
  • downloads/ - Downloads folder

Duplicate Documentation (Keep only README.md)

Remove these duplicate documentation files:

  • BUILD_FIRST.txt
  • CREATE_ICONS.txt
  • DEPLOY.txt
  • DEPLOYMENT_SUMMARY.txt
  • DIAGNOSE.bat
  • EASIEST_WAY.txt
  • EXPOSE_LOCAL.txt
  • GITHUB_DEPLOY.txt
  • HOST_ONLINE_NOW.txt
  • HOW_TO_PREVIEW.txt
  • INSTALL_NODEJS.txt
  • MANUAL_START.txt
  • NETLIFY_DEPLOY.txt
  • QUICK_COMMANDS.txt
  • QUICK_DEPLOY.txt
  • README_PREVIEW.txt
  • REVERT.txt
  • START_HERE.txt
  • STEP_BY_STEP.txt
  • TROUBLESHOOTING.txt
  • VERCEL_DEPLOY.txt
  • WHAT_TO_DO_NOW.txt
  • build.bat, build-simple.bat
  • fix-localhost.bat
  • open-preview.bat
  • preview.bat
  • QUICK_HOST.bat
  • start.bat, start-simple.bat
  • test-node.bat
  • preview.html
  • OPEN_THIS.html
  • SIMPLE_START.html

Consolidate Documentation

Keep only these essential .md files:

  • README.md - Main documentation
  • LICENSE - License

Optional (if you want to keep some):

  • GITHUB_PAGES_SETUP.md - GitHub deployment guide
  • DEPLOYMENT_READY.md - Deployment checklist

Remove these duplicate .md files:

  • COMPREHENSIVE_APP_CHECK.md
  • CREATE_PWA_ICONS.md
  • DASHBOARD_ENHANCEMENTS.md
  • DEPLOY_GITHUB.md
  • DEPLOYMENT_COMPLETE.md
  • FINAL_ENHANCEMENTS_SUMMARY.md
  • FINAL_GITHUB_SETUP.md
  • GENERATE_NATIVE_APPS.md
  • GITHUB_PUBLISH_CHECKLIST.md
  • GITHUB_READY.md
  • META_TAGS_UPGRADE.md
  • MOBILE_COMPATIBILITY_GUIDE.md
  • PUBLISH_APP.md
  • PUBLISH_TO_GITHUB.md
  • QUALITY_ENHANCEMENTS.md
  • ROLE_ACCESS_POLICY.md
  • SECURITY_AND_FEATURES_ANALYSIS.md
  • SETTINGS_INTEGRATION.md
  • SETUP_DIRECT_DOWNLOADS.md
  • TROUBLESHOOT_LOCALHOST.md
  • ZAR_CURRENCY_UPDATE.md

📋 Cleanup Steps

  1. Update .gitignore (already done)
  2. Remove temporary files (bat, ps1, txt, html)
  3. Remove build artifacts (dist folder)
  4. Consolidate documentation (keep only README.md)
  5. Ensure node_modules is ignored

🎯 Final Repository Structure

Application/
├── .github/
│   └── workflows/
│       └── deploy.yml
├── public/
│   ├── browserconfig.xml
│   ├── robots.txt
│   ├── sitemap.xml
│   └── vite.svg
├── src/
│   ├── components/
│   ├── pages/
│   ├── store/
│   ├── types/
│   ├── utils/
│   ├── App.tsx
│   ├── index.css
│   └── main.tsx
├── .gitignore
├── index.html
├── LICENSE
├── netlify.toml (optional)
├── package.json
├── package-lock.json
├── postcss.config.js
├── README.md
├── tailwind.config.js
├── tsconfig.json
├── tsconfig.node.json
├── vercel.json (optional)
└── vite.config.ts

This structure keeps only essential files and reduces repository size significantly.