micronas-monitor v1.1.0

MICRO NAS - Monitor

This is a web page for users to view, access, and configure their very own MICRO NAS through a user-friendly interface.

Acknowledgements

• Orange Pi Zero 3 - The SBC (Single Board Computer) used as the base for the MICRO NAS.
• Armbian OS - The OS (Operating System) used to operate the MICRO NAS, specifically, the server/headless installation.
• ZeroTier - The VN (Virtual Network) used to connect the MICRO NAS over the Wide Area Network for convenient access.

Authors

• @NefydHP - Repository author and Webpage developer
• @SqueekCheese - Modular Information Card-based Resource Organizer (MICRO) NAS inventor.

DISCLAIMER

This project is still under beta. Data found in the website may be incomplete or are substitutes.

Deployment

To deploy this project run

  npm run deploy

or

  node server.js

Installation & Usage

Prerequisites

Ensure you have Node.js installed. If you don't have it, download and install it from:

🔗 https://nodejs.org/ (Node.js comes with npm and npx by default.)

Installation Options

Run Without Installation (Recommended for One-Time Use)

You can run the tool directly using npx (no installation needed):

npx micronas-monitor

Install Locally (Recommended for Projects)

If you want to use the tool in a project, install it locally:

npm install micronas-monitor

Then run it with:

npx micronas-monitor

Install Globally (Recommended for System-Wide Use)

To install it globally on your system:

npm install -g micronas-monitor

Now you can run it from anywhere:

micronas-monitor

Uninstallation

If you no longer need it, remove it with:

For global installation:

npm uninstall -g micronas-monitor

For local installation:

npm uninstall micronas-monitor

Features

• Dashboard for introduction, resources, links, and socials.
• Disks Page for viewing and modifying files inside your MICRO NAS.
• Settings Page for configuring website theme (light/dark), among other things.
• Login Page for initializing the MICRO NAS' IP address, the username you wish to use, and the user password.

Feedback

If you have any feedback, please reach out to us at group2.iii.gnhs@gmail.com