ulysia/szurubooru
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Image board engine, Danbooru-style.
452 commits 4 branches 22 tags 15 MiB
Python 52.1%
JavaScript 34%
Smarty 8.2%
Stylus 5.2%
Dockerfile 0.2%
Other 0.2%
Find a file
Marcin Kurczewski 88dfc0eb96 Fixed nprogress nesting
2014-10-20 20:01:37 +02:00
data Replaced references to szuru2 with szurubooru 2014-10-19 16:02:19 +02:00
public_html Fixed nprogress nesting 2014-10-20 20:01:37 +02:00
scripts Added script for generating thumbnails 2014-10-18 18:48:42 +02:00
src Fixed searching for liked/disliked posts 2014-10-19 21:19:40 +02:00
tests Abandoned FPDO 2014-10-19 20:09:06 +02:00
.gitignore Added style checkers and build tasks 2014-10-18 18:48:19 +02:00
composer.json Abandoned FPDO 2014-10-19 20:09:06 +02:00
gruntfile.js Added tag categories 2014-10-19 13:13:02 +02:00
INSTALL.md Added README 2014-10-18 18:54:12 +02:00
LICENSE Removed unneeded file; added license 2014-10-18 18:48:11 +02:00
package.json Fixed mousetrap dependency name 2014-10-19 13:42:48 +02:00
phpcheckstyle.cfg Removed print_r from banned functions 2014-10-18 18:48:23 +02:00
README.md Added links to README 2014-10-18 20:05:45 +02:00
TODO Added tag categories 2014-10-19 13:13:02 +02: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.