"In the ancient realm of Software Engineering, where chaos once reigned supreme, five sacred principles emerged from the depths of wisdom, forged by the legendary architects of old. These principles, known as SOLID, became the foundation upon which all great systems were built."
You stand at the gates of the Grand Archive of Design Patterns, a mystical repository where the ancient wisdom of software craftsmanship has been preserved for generations. Within these digital halls, you will discover the sacred scrolls that have guided countless developers through the treacherous lands of code complexity.
Long ago, in the age of tangled code and monolithic beasts, five wise sages emerged with principles that would change the fate of software forever:
-
🔷 The Single Responsibility Sentinel - "One purpose, one guardian"
Each class must guard only one sacred duty, for a guardian divided is a guardian weakened. -
🔮 The Open/Closed Oracle - "Open to growth, sealed against corruption"
Like the enchanted gates of the ancient citadel, your code must welcome extension while remaining impervious to modification. -
🌟 The Liskov Substitution Sage - "The child shall inherit the parent's covenant"
Any descendant must honor the sacred contract of its ancestors, maintaining the ancient promises without breaking the realm's harmony. -
⚡ The Interface Segregation Sorcerer - "No soul shall bear unwanted burdens"
Split the mighty interfaces into focused fragments, for no client should be forced to wield powers they do not seek. -
🗝️ The Dependency Inversion Diviner - "Depend upon abstractions, not the earthly forms"
The high towers must not rest upon the unstable ground below; both shall stand upon the eternal foundations of abstraction.
Beyond the SOLID pillars lie the Patterns of Power, ancient techniques discovered by the Guild of Four and their disciples:
Where objects are born from the primordial void:
- Singleton 🔒 - The Lone Guardian
- Factory Method 🏭 - The Artisan's Workshop
- Abstract Factory 🏗️ - The Grand Manufactory
- Builder 🔨 - The Master Craftsman
- Prototype 📋 - The Mirror of Duplication
Where components unite to form greater wholes:
- Adapter 🔌 - The Bridge Between Worlds
- Bridge 🌉 - The Separator of Concerns
- Composite 🌳 - The Tree of Unity
- Decorator 🎨 - The Enchanter's Touch
- Facade 🎭 - The Simplified Gateway
Where objects communicate in elegant choreography:
- Observer 👁️ - The Watchful Eye
- Strategy ♟️ - The Tactical Master
- Command ⚡ - The Executor's Decree
- Iterator 🔄 - The Path Walker
- State 🎯 - The Shapeshifter
Before you begin your journey, ensure you possess:
- Node.js (v18 or higher) - The Runtime Crystal
- npm or yarn - The Package Grimoire
- A brave heart and curious mind
# Clone the ancient repository
git clone https://github.com/manish-1614/solid-design-patterns.git
# Enter the sacred grounds
cd solid-design-patterns
# Invoke the dependencies
npm install
# Awaken the development server
npm run devOnce the portal is open, navigate your browser to:
http://localhost:3000
Behold! The Software Design Mastery interface shall materialize before your eyes, revealing all the sacred knowledge within.
This mystical web application has been crafted with:
- Next.js 16 - The Modern Framework of Power
- React - The Component Conjurer
- TypeScript - The Type-Safe Spellbook
- Tailwind CSS - The Styling Sorcery
- Dark Mode - For those who code in the shadows
- Interactive Cards - Each principle and pattern comes alive with hover enchantments
- Responsive Design - Adapts to all viewing crystals (mobile, tablet, desktop)
- Dark/Light Modes - Choose your realm's ambiance
- Beautiful Gradients - Visual magic that guides your learning journey
- Comprehensive Descriptions - Ancient wisdom distilled into modern understanding
When you're ready to deploy your knowledge to the world:
# Forge the production build
npm run build
# Launch the production server
npm startBehold the live archive at: https://manish-1614.github.io/solid-design-patterns
This repository is enchanted with GitHub Actions! Every time you push to the main branch, the mystical workflow automatically:
- Builds your project
- Exports it as static files
- Deploys to GitHub Pages
To enable the GitHub Pages portal:
- Navigate to your repository settings on GitHub
- Go to Pages in the left sidebar
- Under Source, select GitHub Actions
- The deployment spell will activate automatically on your next push!
# Commit your changes
git add .
git commit -m "Deploy to GitHub Pages"
# Push to the main branch
git push origin mainThe GitHub Actions workflow will automatically build and deploy your site within a few minutes!
This archive is but the beginning of your journey. Use this knowledge to:
- Build systems that stand the test of time
- Write code that future developers will praise
- Avoid the pitfalls that have claimed many before you
- Become a master architect in your own right
Contributions to this sacred archive are welcome! Whether you wish to:
- Add new patterns to the collection
- Enhance the visual enchantments
- Improve the ancient texts
- Fix bugs in the mystical code
Simply fork this repository, make your improvements, and submit a pull request to the Council of Maintainers.
For those who seek deeper wisdom:
- Design Patterns: Elements of Reusable Object-Oriented Software - The Gang of Four's legendary tome
- Clean Code - Uncle Bob's sacred manuscript
- Refactoring - Martin Fowler's guide to transformation
This project is released under the MIT License - free as the wind, open as the sky.
To all the legendary developers who came before us, who fought the battles against complexity and emerged victorious with these timeless principles and patterns. Your wisdom lights our path.
May your code be clean, your bugs be few, and your deployments be successful.
Happy Coding, Noble Developer! ⚔️✨
Made with 💜 by developers, for developers
"The best code is the code that future you will thank present you for writing."