KomuSolutions/szuru
2
0
Fork 0
Code Issues Actions Packages Releases Wiki Activity
Image board engine, Danbooru-style. fork of github.com/rr-/szurubooru https://szuru.libre.moe
833 Commits 5 Branches 22 Tags 15 MiB
Python 52.2%
JavaScript 33.9%
Smarty 8.2%
Stylus 5.2%
Dockerfile 0.2%
Other 0.2%
1.x
Go to file
rr- 31f336d690 Added script for fixing image dimensions
2016-07-28 19:14:43 +02:00
data Fixed tests 2015-11-25 11:39:45 +01:00
public_html Merge pull request #81 from kotcrab/arrows 2016-04-06 08:10:47 +02:00
scripts Added script for fixing image dimensions 2016-07-28 19:14:43 +02:00
src Reduced Imagick memory consumption 2016-07-28 19:14:23 +02:00
tests Fix authorization test 2016-03-09 21:07:04 +01:00
.gitignore Added style checkers and build tasks 2014-10-18 18:48:19 +02:00
composer.json Switched to PHPMailer 2015-06-28 12:24:46 +02:00
gruntfile.js Fix mousetrap library path 2016-03-09 20:12:04 +01:00
INSTALL.md Added MySQL to the list of dependencies 2016-03-08 23:24:13 +01:00
LICENSE Removed unneeded file; added license 2014-10-18 18:48:11 +02:00
package.json Bumped version to 1.1.0 2016-04-13 11:17:52 +02:00
phpcheckstyle.cfg Fixed whitespace 2015-11-25 09:48:03 +01:00
phpunit.xml Added PHPunit.xml 2014-11-09 17:38:58 +01:00
README.md Small OCD fixes to documentation 2016-03-08 21:59:18 +01:00

README.md

szurubooru

szurubooru

What is it?

szurubooru is a Danbooru-style board, a gallery where users can upload, browse, tag and comment images, video clips and flash animations.

Its name have its roots in Polish language and has onomatopoeic meaning of scraping or scrubbing. It is pronounced "shoorubooru" [ˌʃuruˈburu].

Licensing

Please see the file named LICENSE.

Installation

Please see the file named INSTALL.md.

Bugs and feature requests

All bugs and suggestions should be reported as issues on the Github repository page. When reporting, please do following:

  1. Search for existing issues for possible duplicates. If something is related to your problem, comment on that issue instead of opening a new one.
  2. If you found an issue and the issue is closed, feel free to reopen it.
  3. If you're reporting a bug, create an isolated and reproducible scenario.
  4. If you're filing a feature request, provide examples - what might be obvious to you, might not be so obvious to the developers.

Contributing the code

Here are some guidelines on how to contribute:

  • Keep your changes compact.
  • Respect coding standards - be consistent with existing code base.
  • Watch your whitespace - don't leave any characters at the end of the lines.
  • Always run tests before pushing.
  • Before starting, see INSTALL.md.
  • Use grunt to do automatic tasks like minifying Javascript files or running tests. Run grunt --help to see full list of available tasks.

API

szurubooru from version 0.9+ uses REST API. Currently there is no formal documentation; source code behind REST layer lies in src/Controllers/ directory. In order to use the API, bear in mind that you need to:

  1. Have actual user account on the server to do most things (depending on privileges).
  2. Authenticate your requests:
    1. Send user credentials to /auth. You'll receive authentication token in return.
    2. Send this token in X-Authorization-Token header on subsequent requests.

Developers reserve right to change API at any time with neither prior notice nor keeping backwards compatibility.