Skip to content

README.md

Latest commit

 

History

History
169 lines (109 loc) · 3.32 KB

README.md

File metadata and controls

169 lines (109 loc) · 3.32 KB
Raw

CodeVault

CodeVault is a lightweight web-based code storage and management platform designed for students and developers to organize, store, and access source code files securely from anywhere.

Unlike bloated cloud IDEs, CodeVault focuses on simplicity, speed, and clarity — acting as a personal vault for code snippets, assignments, and practice programs.

🚀 Features

  • 🔐 User Authentication

    • Register, login, logout
    • Username-based password reset (no email dependency)

  • 📂 Code File Management

    • Create, view, edit, and delete files
    • Supports C, C++, and generic text-based code files
    • Timestamped file history

  • 🌙 Dark / Light Theme Toggle

    • One-click theme switching
    • Consistent UI across all pages

  • 🧭 Dashboard

    • Centralized view of all stored files
    • Clean card-based layout for easy navigation

  • 🔒 Secure Backend

    • Node.js + Express backend
    • MongoDB for persistent storage
    • Passwords stored securely (hashed)

🛠 Tech Stack

Frontend

  • HTML5
  • CSS3 (Flexbox-based responsive layout)
  • Vanilla JavaScript

Backend

  • Node.js
  • Express.js
  • MongoDB
  • Mongoose

📁 Project Structure

backend/
 ├── models/
 ├── node_modules/
 ├── .env
 ├── package.json
 └── server.js

frontend/
 ├── index.html
 ├── register.html
 ├── dashboard.html
 ├── reset-password.html
 ├── styles.css
 └── other HTML pages

⚙️ Setup Instructions

  1. Clone the repository

    git clone https://github.com/your-username/codevault.git

  2. Install backend dependencies

    cd backend
npm install

  3. Configure .env

    MONGO_URI=your_mongodb_connection_string
PORT=5000

  4. Start the server

    node server.js

  5. Open index.html from the frontend folder in your browser

🎯 Use Cases

  • Storing college programming assignments
  • Maintaining a personal library of algorithms
  • Practicing coding problems without losing files
  • Lightweight alternative to cloud IDEs

🔮 Future Improvements

  • Syntax highlighting
  • Folder-based organization
  • File search and filtering
  • Version history
  • Optional cloud deployment

👤 Author

Developed by Arjun S Pai Computer Science Engineering Student

About CodeVault

CodeVault was built to solve a simple but common problem faced by students and developers — losing, misplacing, or poorly organizing code files across systems and folders.

Instead of relying on heavy cloud IDEs or scattered local files, CodeVault provides a minimal, focused platform where users can securely store and manage their code with ease.

The platform emphasizes:

  • Clean user experience
  • Fast access to files
  • Minimal dependencies
  • Practical real-world usability

CodeVault is not meant to replace professional IDEs. It is designed to complement them by acting as a personal code repository — accessible, organized, and distraction-free.

Why CodeVault?

  • No unnecessary complexity
  • No forced email workflows
  • Designed specifically for students
  • Built with learning and productivity in mind

Vision

To evolve CodeVault into a student-first developer utility, gradually adding features without sacrificing simplicity.