webui/README.md

42 lines
800 B
Markdown
Raw Permalink Normal View History

# WebUI - A Simple File Management Tool
2025-10-02 03:56:07 +03:30
2025-10-02 10:35:50 +03:30
WebUI is a (not very) lightweight and easy-to-use web application for managing files on your server.
2025-10-02 03:57:22 +03:30
## Screenshot
2025-10-02 03:57:22 +03:30
![Preview of WebUI](preview.png)
2025-10-02 10:13:28 +03:30
![Preview of WebUI 2](preview2.png)
2025-10-02 03:57:22 +03:30
## Getting Started
2025-10-02 03:57:22 +03:30
2025-10-02 04:01:22 +02:00
### dependencies
2025-10-02 03:57:22 +03:30
* [Node.js](https://nodejs.org/) installed on your system.
2025-10-02 03:57:22 +03:30
### Installation
2025-10-02 04:01:22 +02:00
1. Clone:
```bash
git clone https://codeberg.org/coast/webui.git
```
2025-10-02 04:01:22 +02:00
2. Navigate to the directory:
```bash
2025-10-02 02:49:30 +02:00
cd webui
```
2025-10-02 04:01:22 +02:00
3. Install dependencies:
```bash
npm install
```
### Usage
1. Start the server:
```bash
node server.js
```
2025-10-02 04:01:22 +02:00
2. Open your browser of choice and go to `http://<SERVER_IP>:3000` or `http://localhost:3000`.
## License
2025-10-02 05:38:49 +03:30
This project is licensed under the [GPL v2.0 License](LICENSE).