🌟 Programming Best Practices
Your comprehensive guide to writing better code across 30+ languages and frameworks
Curated resources from industry leaders • Production-ready practices • Always updated
📖 Introduction
This repository is a curated collection of programming best practices across multiple languages, frameworks, and tools.
It is not an exhaustive list but rather a practical resource containing articles, guidelines, and style guides that have proven helpful in real-world development.
The focus is primarily on Web Development (Ruby, Rails, JavaScript, etc.), but it also covers databases, DevOps, cloud practices, AI tools, and career growth.
With this collection, I hope to support developers in writing cleaner, more maintainable code and growing in their careers.
Status: 🚧 Work in Progress — continuously updated
🎯 Why This Repository?
✨ Curated Quality — Hand-picked resources from industry leaders and experienced developers
🚀 Production-Ready — Practices that work in real-world applications, not just theory
🌍 Multi-Language — Covers 30+ programming languages and frameworks
📚 Comprehensive — From code style to architecture, security to performance
🔄 Always Updated — Regularly maintained with the latest best practices
💡 Community-Driven — Open to contributions from developers worldwide
🚀 Quick Start Setup
🎯 Automated Setup (Recommended)
The fastest way to get started is using our automated setup script:
# Clone the repository
git clone https://github.com/dereknguyen269/programing-best-practices.git
cd programing-best-practices
# Run the interactive setup script
./scripts/quick-start.sh
The script will guide you through different setup options:
| Mode | Time | What's Included |
|---|
| Minimal | ~1 min | Dependencies only, no crawling |
| Test | ~2-3 min | Dependencies + 20 sample resources |
| Full | ~10-15 min | Everything + all 150+ resources + AI summaries |
| Custom | Varies | Choose specific categories to crawl |
Quick Options:
# Minimal setup (just dependencies)
./scripts/quick-start.sh --minimal
# Full setup (everything)
./scripts/quick-start.sh --full
# Test with 20 resources
./scripts/quick-start.sh --limit 20
# Crawl only Python resources
./scripts/quick-start.sh --category python
📋 Manual Setup (Alternative)
Prefer to set up manually? Follow these steps:
Step 1: Clone the Repository
git clone https://github.com/dereknguyen269/programing-best-practices.git
cd programing-best-practices
Step 2: Install Crawler Dependencies (Optional but Recommended)
The crawler downloads all external resources locally for offline access:
# Create virtual environment (recommended)
python3 -m venv .venv
source .venv/bin/activate # On Windows: .venv\Scripts\activate
# Install dependencies
pip install -r scripts/crawler/requirements.txt
Step 3: Crawl Resources (Optional)
Download all best practices content locally:
Note: Make sure your virtual environment is activated before running these commands:
source .venv/bin/activate # On Windows: .venv\Scripts\activate
Or use the venv Python directly: .venv/bin/python3 instead of python3
# Crawl all resources (~150+ links, takes 10-15 minutes)
python3 scripts/crawler/crawl.py
# Or crawl specific categories
python3 scripts/crawler/crawl.py --category python
python3 scripts/crawler/crawl.py --category javascript
# Or crawl a limited number for testing
python3 scripts/crawler/crawl.py --limit 20
# Update existing content
python3 scripts/crawler/crawl.py --update
