Merge pull request 'Update README and add node stuff' (#1) from Soccera/webui:main into main

Reviewed-on: https://codeberg.org/coast/webui/pulls/1
This commit is contained in:
Coasteen McShoremann 2025-10-02 03:42:30 +02:00
commit ed4b121081
4 changed files with 1068 additions and 6 deletions

1
.gitignore vendored Normal file
View file

@ -0,0 +1 @@
node_modules

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
```
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).

1004
package-lock.json generated Normal file

File diff suppressed because it is too large Load diff

20
package.json Normal file
View file

@ -0,0 +1,20 @@
{
"name": "webui",
"version": "1.0.0",
"description": "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.",
"main": "script.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"start": "node server.js"
},
"repository": {
"type": "git",
"url": "https://codeberg.org/Soccera/webui.git"
},
"keywords": [],
"author": "",
"dependencies": {
"express": "^4.17.1",
"multer": "^1.4.5-lts.1"
}
}