Table of Contents

1. About The Project
   • Features
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Module Development
4. License

About The Project

ContaraNAS is a modular desktop application designed for monitoring and managing NAS systems at home.

(back to top)

Features

• Steam Library Monitor - Track game installations and library sizes across your NAS
• System Monitor - Real-time CPU, memory, and disk usage monitoring
• Real-time Updates - WebSocket-based live data streaming for instant feedback
• Extensible Design - Build custom modules using the developer API
• Community Marketplace - Share and discover community-built modules (coming soon)

(back to top)

Built With

Frontend:

• TypeScript
• Tauri
• Svelte 5
• SvelteKit
• Vite
• MessagePack
• Lucide Svelte

Backend:

• Python 3.13+
• FastAPI
• Uvicorn
• WebSockets
• aiohttp
• msgspec
• Pydantic
• Loguru
• Click

Documentation:

• MkDocs

(back to top)

Getting Started

Get ContaraNAS up and running on your local machine.

Prerequisites

Linux

1. Python 3.13+

   Verify your version:

   python --version  # Should be 3.13 or higher
   

   If you need Python 3.13+, install via your package manager or python.org

2. uv (Python package manager)

   Arch Linux:

   sudo pacman -S uv
   

   Debian/Ubuntu and other distributions:

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

3. Node.js 18+ and bun

   Arch Linux:

   sudo pacman -S nodejs npm
   curl -fsSL https://bun.sh/install | bash
   

   Debian/Ubuntu:

   # Install Node.js 20.x
   curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
   sudo apt-get install -y nodejs
   
   # Install bun
   curl -fsSL https://bun.sh/install | bash
   

   Other distributions (via package manager or nodejs.org):

   # After installing Node.js:
   curl -fsSL https://bun.sh/install | bash
   

4. Rust (for Tauri)

   All distributions:

   curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
   source $HOME/.cargo/env  # Or restart your terminal
   

Windows

1. Python 3.13+

   Download and install from python.org

2. uv (Python package manager)

   PowerShell:

   powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
   

3. Node.js 18+ and bun

   Download Node.js from nodejs.org, then install bun:

   powershell -c "irm bun.sh/install.ps1 | iex"
   

4. Rust (for Tauri)

   Download and install from rustup.rs

(back to top)

Installation

1. Clone the repository

   git clone https://github.com/MihaiStreames/ContaraNAS.git
   cd ContaraNAS
   

2. Set up the backend

   cd backend
   uv sync
   

3. Set up the frontend

   cd frontend
   bun install
   

4. Run the application

   In one terminal (backend):

   cd backend
   uv run -m ContaraNAS
   

   In another terminal (frontend):

   cd frontend
   bun run tauri dev
   

(back to top)

Module Development

ContaraNAS features a powerful module system that allows you to extend functionality. Full documentation is available at contaranas.xyz.

(back to top)

License

[!IMPORTANT] ContaraNAS is licensed under the GNU General Public License v3.0.

This means:

• ✅ You can use, modify, and distribute this software
• ✅ You can use it for commercial purposes
• ⚠️ You must disclose the source code of any modifications
• ⚠️ You must license derivative works under GPL-3.0
• ⚠️ You must include copyright and license notices

See LICENSE for complete terms, or read the official GPL-3.0 documentation.

(back to top)

---