RemoteFS

A lightweight local-network file management application for browsing, uploading, downloading, and managing files on a host machine from any device on your LAN.

Overview

RemoteFS provides a clean web interface for essential file system operations with real-time updates. Built for home networks, internal tools, and lightweight remote management scenarios with passcode-based authentication for secure access.

Features

• Passcode authentication: Secure access with one-time passcode shown in server CLI
• Real-time sync via WebSocket connections
• Auto-refresh on file system changes using Chokidar
• File operations: upload, download, create, delete
• Folder management: create, navigate, delete (folders downloaded as ZIP)
• Search with instant filtering
• Responsive UI built with React and shadcn/ui
• Live connection status indicator

Tech Stack

Frontend

• React (Vite + React Router) + shadcn/ui
• TailwindCSS
• Zustand for state management
• WebSocket client

Backend

• Node.js
• Express
• WebSocket server
• Archiver for folder compression
• Chokidar for file system watching

Build System

• Turborepo for monorepo orchestration

Project Structure

apps/
  ├── client/       # React frontend
  ├── server/       # Node.js backend
packages/
  └── utils/        # Shared utilities and types
turbo.json          # Turborepo configuration

Getting Started

Prerequisites

• Node.js 16+
• npm

Installation

# Clone the repository
git clone https://github.com/Bhavye2003Developer/RemoteFS.git
cd RemoteFS

# Install dependencies
npm install

Configuration

1. Find your local IP address:

   • Windows: Run ipconfig
   • macOS: Run ifconfig
   • Linux: Run ip a

2. Open ./packages/utils/constants.ts

3. Set your local IP:

   export const SYSTEM_IP = "192.168.1.x"; // Replace with your IP

Development

# Start both client and server
npm run dev

The build system will automatically initialize both applications.

Access the application:

• Desktop: http://<your-ip>:5555
• Mobile: http://<your-ip>:5555 (same network required)

Authentication: Enter the passcode shown in the server CLI when prompted to access the file explorer.

Architecture

RemoteFS uses a WebSocket-based architecture for real-time communication:

1. User accesses the application and enters the passcode displayed in server CLI
2. Client establishes persistent WebSocket connection
3. Chokidar watches the current directory for file system changes
4. File operations trigger WebSocket messages
5. Server processes filesystem changes (folders compressed using Archiver for download)
6. Server broadcasts updates to connected clients
7. UI automatically refreshes

API

HTTP Endpoints

• POST /upload - Upload files
• GET /download?fileInfo=... - Download files

WebSocket Events

• FETCH - Retrieve directory contents
• ADD - Create file or folder
• DELETE - Remove file or folder
• DOWNLOAD - Download file or folder

Security

• Passcode-based authentication protects against unauthorized access
• Passcode is generated on server startup and displayed in CLI
• Access is restricted to devices on the same local network

License

This project is licensed under the MIT License.