GuideVault

🚀 GuideVault 🚀

GuideVault is a comprehensive documentation warehouse that provides structured learning paths using official documentation for developers. Master React, TypeScript, Next.js, Tailwind CSS, and 25+ technologies through curated paths that focus on official docs—no tutorials, no rewrites—just the right order.

---

📋 Table of Contents

• 🚀 Features
• 🛠️ Technologies Covered
• 📦 Installation
• 🏗️ Build & Development
• 📁 Project Structure
• 🔍 How It Works
• 🤝 Contributing
• 📞 Contact

---

   _____
  /     \
 /  🐍   \
|   Guide  |
 \  Vault /
  \_____/
     ||
     ||
    /  \
   |    |
   |    |
   |____|
  /      \
 |  Learn  |
  \______/

Welcome to GuideVault - Your Ultimate Learning Companion!

🎮 Learning Progress

Frontend Mastery

React: ████████░░ 80% TypeScript: ███████░░░ 70% Next.js: ████████░░ 80%

Backend Mastery

Node.js: ███████░░░ 70% Python: ███████░░░ 70% PostgreSQL: ███████░░░ 70%

DevOps & Cloud

Docker: ███████░░░ 70% AWS: ███████░░░ 70% Linux: ███████░░░ 70%

---

🛠️ Tech Stack

🚀 Features

• Structured Learning Paths: Curated sequences of official documentation for efficient learning
• Universal Search: Powerful search functionality across all technologies and documentation
• 25+ Technologies Covered: From React and TypeScript to Rust, Go, and cloud platforms
• Dark Mode Support: Seamless dark/light theme switching
• Keyboard Shortcuts: Enhanced navigation and productivity
• Mobile Responsive: Optimized for all devices
• Official Documentation Focus: Direct links to authoritative sources

🛠️ Technologies Covered

Frontend

Backend

Languages

Cloud & DevOps

Other

📦 Installation

1. Clone the repository

   git clone https://github.com/CodewithEvilxd/GuideVault.git
   cd GuideVault

2. Install dependencies

   npm install

3. Start development server

   npm run dev

4. Open your browser Navigate to http://localhost:5173

🏗️ Build & Development

Available Scripts

• npm run dev - Start development server
• npm run build - Build for production
• npm run preview - Preview production build
• npm run lint - Run ESLint
• npm run take-screenshots - Generate screenshots (requires Puppeteer)

Tech Stack

• Framework: React 19
• Build Tool: Vite
• Language: TypeScript
• Styling: Tailwind CSS
• Animations: Framer Motion
• Routing: TanStack Router
• Search: MiniSearch
• Deployment: Vercel

📁 Project Structure

guidevault/
├── public/                 # Static assets
│   ├── images/            # Technology logos and screenshots
│   └── favicon.svg
├── src/
│   ├── components/        # Reusable UI components
│   ├── pages/            # Page components
│   ├── data/             # Learning paths and search data
│   ├── hooks/            # Custom React hooks
│   ├── lib/              # Utility functions
│   └── types/            # TypeScript type definitions
├── scripts/               # Build and utility scripts
└── package.json

🔍 How It Works

GuideVault organizes official documentation into logical learning sequences:

1. Domains: High-level categories (Frontend, Backend, DevOps, etc.)
2. Languages: Programming language-specific paths
3. Skills: Technology-specific deep dives

Each path provides direct links to official documentation in the optimal learning order.

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

Adding New Technologies

1. Add technology data to src/data/
2. Include official documentation links
3. Update search indexes
4. Add logo to public/images/

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Built with ❤️ for the developer community
• Powered by official documentation from technology creators
• Inspired by the need for structured, authoritative learning resources

📞 Contact

---

Accelerate your development journey with comprehensive documentation and in-depth guides.