projects / uguu.git / blame
| Commit | Line | Data |
|---|---|---|
| e52293dd GJ |
1 | # Uguu |
| 2 | [](https://sonarcloud.io/dashboard?id=nokonoko_Uguu) | |
| f458ad8c | 3 | [](https://www.gnu.org/licenses/gpl-3.0) |
| 7887c7e4 | 4 | [](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 | ||
| 07da4421 | 37 | If you need a admin panel check out [Moe Panel](https://github.com/pomf/MoePanel). |
| d501210d | 38 | |
| d8c46ff7 GJ |
39 | ## Getting help |
| 40 | ||
| 63cfe4f6 | 41 | Hit me up at [@nekunekus](https://twitter.com/nekunekus) or email me at neku@pomf.se |
| e3fe8ee9 | 42 | |
| 13019c73 GJ |
43 | ## Contributing |
| 44 | ||
| 45 | We'd really like if you can take some time to make sure your coding style is | |
| 46 | consistent with the project. Uguu follows [PHP | |
| 47 | PSR-12](https://www.php-fig.org/psr/psr-12/) and [Airbnb JavaScript | |
| 48 | (ES5)](https://github.com/airbnb/javascript/tree/es5-deprecated/es5) (`airbnb/legacy`) | |
| 49 | coding style guides. We use ESLint and PHPCS tools to enforce these standards. | |
| 50 | ||
| 51 | You can also help by sending us feature requests or writing documentation and | |
| 52 | tests. | |
| 53 | ||
| d8c46ff7 | 54 | ## Credits |
| 67a54d5c | 55 | |
| 0c9a152f | 56 | 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 | 57 | |
| d8c46ff7 | 58 | ## License |
| 2239bd05 | 59 | |
| 83db6ff1 | 60 | Uguu is free software, and is released under the terms of the GPL-3.0 license. See |
| 56586dec | 61 | `LICENSE`. |