1
0
mirror of https://github.com/nokonoko/Uguu.git synced 2024-01-06 13:35:15 +00:00
uguu/README.md

66 lines
2.1 KiB
Markdown
Raw Normal View History

2021-06-23 21:23:17 +00:00
# Uguu
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nokonoko_Uguu&metric=alert_status)](https://sonarcloud.io/dashboard?id=nokonoko_Uguu)
2022-01-22 19:02:37 +00:00
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
2021-06-23 21:25:34 +00:00
[![Documentation Status](https://docs.uguu.se/img/flat.svg)](https://docs.uguu.se)
2021-06-23 21:23:17 +00:00
2020-11-18 12:54:47 +00:00
# What is Uguu?
2021-06-24 11:46:00 +00:00
Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host.
## Features
- One click uploading, no registration required
- A minimal, modern web interface
2021-06-23 17:22:26 +00:00
- Drag & Drop & Paste supported
- Upload API with multiple response choices
- JSON
- HTML
- Text
- CSV
- Supports [ShareX](https://getsharex.com/) and other screenshot tools
### Demo
2021-06-23 23:59:58 +00:00
See the real world site at [uguu.se](https://uguu.se).
2015-02-11 17:01:03 +00:00
## Requirements
2016-05-15 15:06:36 +00:00
2022-01-22 21:57:32 +00:00
Tested and working with Nginx + PHP-8.0/8.1 + SQLite/MySQL.
2022-01-22 21:57:32 +00:00
Node is used to compile Uguu, after that it runs on PHP.
2021-06-22 18:37:28 +00:00
2021-06-23 22:18:41 +00:00
## Installation
Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se).
2022-04-17 08:50:53 +00:00
If you need a admin panel check out [Moe Panel](https://git.pomf.se/Pomf/MoePanel).
2020-11-18 13:00:15 +00:00
2022-04-17 13:22:36 +00:00
## Docker
For Docker read [this guide](https://git.pomf.se/Pomf/uguu/wiki/Deploying-using-Docker).
## Getting help
2020-11-18 11:56:49 +00:00
Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se
2016-05-15 15:06:36 +00:00
2022-01-22 20:34:29 +00:00
## Contributing
We'd really like if you can take some time to make sure your coding style is
consistent with the project. Uguu follows [PHP
PSR-12](https://www.php-fig.org/psr/psr-12/) and [Airbnb JavaScript
(ES5)](https://github.com/airbnb/javascript/tree/es5-deprecated/es5) (`airbnb/legacy`)
coding style guides. We use ESLint and PHPCS tools to enforce these standards.
You can also help by sending us feature requests or writing documentation and
tests.
## Credits
2015-02-11 17:01:03 +00:00
2021-06-05 15:08:07 +00:00
Uguu is based on [Pomf](http://github.com/pomf/pomf) which was written by Emma Lejack & Eric Johansson (nekunekus) and with help from the open source community.
2016-05-14 09:30:07 +00:00
## License
2016-05-14 09:30:07 +00:00
2022-01-22 16:53:33 +00:00
Uguu is free software, and is released under the terms of the GPL-3.0 license. See
2021-06-23 22:18:41 +00:00
`LICENSE`.