https://github.com/justwaitfor-me/vaultos
VaultOS is a modern and scalable home server dashboard designed for data management, remote access, and personal cloud storage.
https://github.com/justwaitfor-me/vaultos
dashboard home home-cloud home-dashboard home-server
Last synced: 6 months ago
JSON representation
VaultOS is a modern and scalable home server dashboard designed for data management, remote access, and personal cloud storage.
- Host: GitHub
- URL: https://github.com/justwaitfor-me/vaultos
- Owner: justwaitfor-me
- License: mit
- Created: 2025-03-25T20:56:27.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-03-25T21:18:44.000Z (7 months ago)
- Last Synced: 2025-03-25T22:26:45.580Z (7 months ago)
- Topics: dashboard, home, home-cloud, home-dashboard, home-server
- Language: TypeScript
- Homepage:
- Size: 41 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VaultOS
VaultOS is a modern and scalable home server dashboard designed for data management, remote access, and personal cloud storage.
## Features
- **Dashboard:** Real-time data visualization (e.g., solar panel data)
- **Cloud Storage:** File and media management
- **User Management:** Secure authentication with Auth0
## Tech Stack
- **Frontend:** Next.js, TailwindCSS
- **Backend:** Node.js, Express, MongoDB
- **Authentication:** Auth0
## Installation
1. **Clone the repository:**
```sh
git clone https://github.com/justwaitfor-me/VaultOS.git
cd VaultOS
```
2. **Backend Setup:**
```sh
cd backend
npm install
touch config/.env # Add authentication & database credentials
```
3. **Frontend Setup:**
```sh
cd ../frontend
npm install
```
4. **Start Development Servers:**
- **Backend:**
```sh
cd backend
node server.js
```
- **Frontend:**
```sh
cd frontend
npm run dev
```
## Future Plans
- **Document Editor** (like Google Docs)
- **Virtual Desktops** (Docker-based remote system)
- **PC Manager** (Remote control of home computers)
- **Local AI** (Self-hosted chatbot with API access)
## Repository Structure
``` sh
VaultOS/
│── backend/ # Backend services
│ ├── controllers/ # Business logic
│ ├── models/ # Database models (MongoDB schemas)
│ ├── routes/ # API endpoints
│ ├── services/ # Utility services (e.g., authentication, file handling)
│ ├── config/ # Config files
│ ├── tests/ # Backend unit tests
│ ├── server.js # Main server file
│── frontend/ # Frontend application (Next.js)
│ ├── components/ # Reusable UI components
│ ├── pages/ # Next.js pages
│ ├── styles/ # Tailwind CSS styles
│ ├── hooks/ # Custom React hooks
│ ├── utils/ # Frontend utility functions
│ ├── contexts/ # Context providers
│ ├── public/ # Static assets
│── .gitignore # Git ignore file
│── README.md # Project documentation
```