]>
Commit | Line | Data |
---|---|---|
e52293dd GJ |
1 | # Uguu |
2 | [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nokonoko_Uguu&metric=alert_status)](https://sonarcloud.io/dashboard?id=nokonoko_Uguu) | |
f458ad8c | 3 | [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) |
7887c7e4 | 4 | [![Documentation Status](https://docs.uguu.se/img/flat.svg)](https://docs.uguu.se) |
e52293dd GJ |
5 | |
6 | ||
295794b7 | 7 | # What is Uguu? |
d8c46ff7 | 8 | |
0b95d9d1 | 9 | Uguu is a simple lightweight temporary file hosting and sharing platform, but can also be used as a permanent file host. |
d8c46ff7 GJ |
10 | |
11 | ## Features | |
12 | ||
13 | - One click uploading, no registration required | |
14 | - A minimal, modern web interface | |
13a9292f | 15 | - Drag & Drop & Paste supported |
d8c46ff7 GJ |
16 | - Upload API with multiple response choices |
17 | - JSON | |
18 | - HTML | |
19 | - Text | |
20 | - CSV | |
21 | - Supports [ShareX](https://getsharex.com/) and other screenshot tools | |
22 | ||
23 | ### Demo | |
24 | ||
ab5bedd3 | 25 | See the real world site at [uguu.se](https://uguu.se). |
67a54d5c | 26 | |
d8c46ff7 | 27 | ## Requirements |
e3fe8ee9 | 28 | |
eec51db0 | 29 | Tested and working with Nginx + PHP-8.0/8.1 + SQLite/MySQL. |
d8c46ff7 | 30 | |
eec51db0 | 31 | Node is used to compile Uguu, after that it runs on PHP. |
d3f3618d | 32 | |
56586dec GJ |
33 | ## Installation |
34 | ||
35 | Installation and configuration can be found at [Uguu Documentation](https://docs.uguu.se). | |
36 | ||
c37c18d7 | 37 | If you need a admin panel check out [Moe Panel](https://git.pomf.se/Pomf/MoePanel). |
d501210d | 38 | |
2d4a30d6 GJ |
39 | ## Docker |
40 | ||
41 | For Docker read [this guide](https://git.pomf.se/Pomf/uguu/wiki/Deploying-using-Docker). | |
42 | ||
d8c46ff7 GJ |
43 | ## Getting help |
44 | ||
63cfe4f6 | 45 | Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se |
e3fe8ee9 | 46 | |
13019c73 GJ |
47 | ## Contributing |
48 | ||
49 | We'd really like if you can take some time to make sure your coding style is | |
50 | consistent with the project. Uguu follows [PHP | |
51 | PSR-12](https://www.php-fig.org/psr/psr-12/) and [Airbnb JavaScript | |
52 | (ES5)](https://github.com/airbnb/javascript/tree/es5-deprecated/es5) (`airbnb/legacy`) | |
53 | coding style guides. We use ESLint and PHPCS tools to enforce these standards. | |
54 | ||
55 | You can also help by sending us feature requests or writing documentation and | |
56 | tests. | |
57 | ||
d8c46ff7 | 58 | ## Credits |
67a54d5c | 59 | |
0c9a152f | 60 | 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. |
2239bd05 | 61 | |
d8c46ff7 | 62 | ## License |
2239bd05 | 63 | |
83db6ff1 | 64 | Uguu is free software, and is released under the terms of the GPL-3.0 license. See |
56586dec | 65 | `LICENSE`. |