Skip to content

rushdv/brain-vault

Repository files navigation

🧠 Brain Vault

A personal knowledge repository with a modern web interface. This is a central hub for all academic notes, project documentation, and self-learning resources.

🌐 Live Deployments


πŸ—οΈ Project Structure

brain-vault/
β”œβ”€β”€ frontend/              # React + Vite application
β”œβ”€β”€ backend/               # FastAPI backend server
β”œβ”€β”€ docs/                  # Documentation
β”œβ”€β”€ scripts/               # Utility scripts
└── .github/workflows/     # CI/CD configuration

Frontend

  • Framework: React 18 + Vite
  • Styling: Tailwind CSS
  • Features: Content browsing, resource management, responsive design

Backend

  • Framework: FastAPI
  • Features: RESTful API, CORS support, health checks

πŸš€ Quick Start

Prerequisites

  • Node.js 18+
  • Python 3.9+

Setup

# Clone the repository
git clone https://github.com/yourusername/brain-vault.git
cd brain-vault

# Run setup script
bash scripts/setup.sh

Development

# Terminal 1: Frontend
cd frontend && npm run dev

# Terminal 2: Backend
cd backend && source venv/bin/activate && uvicorn app.main:app --reload

For detailed setup instructions, see docs/SETUP.md


πŸ“š Documentation


πŸ“ Content Structure

πŸ’» Computer Science

  • Algorithms & Data Structures
  • Web Development (React & Python)
  • C++ Programming
  • System Design

πŸ›‘οΈ Cybersecurity

  • Ethical Hacking
  • Network Analysis
  • Security Concepts

πŸ“ Engineering & Science

  • Mathematics III
  • Physics II
  • Electrical Engineering

πŸ”„ Current Roadmap (Spring 2026)

Features

  • Search functionality
  • User authentication
  • Content tagging system
  • Dark mode support
  • Mobile app

Academic

  • Algorithm Design
  • Advanced Mathematics
  • Electrical Engineering
  • Modern Physics

Projects

  • Nexum: Social media platform
  • debug-ai: AI-powered CLI error solver

πŸ› οΈ Tech Stack

Frontend

  • React 18
  • Vite
  • Tailwind CSS
  • React Router
  • Axios

Backend

  • FastAPI
  • Uvicorn
  • Pydantic
  • Python 3.9+

DevOps

  • GitHub Actions (CI/CD)
  • Vercel (Frontend Deployment)
  • Docker (Optional)

πŸ“ License

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


🀝 Contributing

Contributions are welcome! Please read CONTRIBUTING.md for details on our code of conduct and the process for submitting pull requests.


πŸ“§ Contact

For questions or suggestions, feel free to open an issue or reach out.

"The mind is not a vessel to be filled, but a fire to be kindled."

About

🧠 The core memory bank for all technical intelligence. Archiving algorithms, cybersecurity research, and architectural blueprints for future builds.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors