Update README.md

Signed-off-by: Soccera <soccera@noreply.codeberg.org>
This commit is contained in:
Soccera 2025-10-02 02:49:08 +02:00
parent f32ce5e4b1
commit f15de6ec13

View file

@ -1,15 +1,52 @@
# WebUI
# WebUI - A Simple File Management Tool
Just a thing for my home server. It is used to manage files.
WebUI is a lightweight and easy-to-use web application for managing files on your server. It provides a simple interface to upload, download, delete, and preview files.
## Features
See preview.png.
* **File Uploading:** Upload one or more files at a time.
* **File Listing:** View a list of all uploaded files with their size and modification date.
* **File Download:** Download files to your local machine.
* **File Deletion:** Remove files from the server.
* **File Preview:** Preview text and image files directly in the browser.
## Screenshot
Feel free to use.
![Preview of WebUI](preview.png)
## Getting Started
Contributing: Accepting contributions!
### Prerequisites
* [Node.js](https://nodejs.org/) installed on your system.
License: APSL 2
### Installation
1. Clone the repository:
```bash
git clone https://codeberg.org/coast/webui.git
```
2. Navigate to the project directory:
```bash
cd webui-server
```
3. Install the dependencies:
```bash
npm install
```
### Usage
1. Start the server:
```bash
node server.js
```
2. Open your web browser and go to `http://localhost:3000`.
## Contributing
Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.
## License
This project is licensed under the [APSL 2.0 License](LICENSE).