2014-10-18 19:55:57 +02:00
|
|
|
|
|
|
|
|
|
|
|
2014-10-18 17:48:11 +02:00
|
|
|
|
szurubooru
|
2014-10-18 19:55:57 +02:00
|
|
|
|
==========
|
2014-10-18 17:48:11 +02:00
|
|
|
|
|
|
|
|
|
|
## What is it?
|
|
|
|
|
|
|
2016-03-08 21:54:29 +01:00
|
|
|
|
`szurubooru` is a Danbooru-style board, a gallery where users can upload,
|
|
|
|
|
|
browse, tag and comment images, video clips and flash animations.
|
2014-10-18 17:48:11 +02:00
|
|
|
|
|
|
|
|
|
|
Its name have its roots in Polish language and has onomatopoeic meaning of
|
|
|
|
|
|
scraping or scrubbing. It is pronounced *"shoorubooru"* [ˌʃuruˈburu].
|
|
|
|
|
|
|
|
|
|
|
|
## Licensing
|
|
|
|
|
|
|
2016-03-08 21:54:29 +01:00
|
|
|
|
Please see the file named
|
|
|
|
|
|
[`LICENSE`](https://github.com/rr-/szurubooru/blob/master/LICENSE).
|
2014-10-18 17:48:11 +02:00
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
2016-03-08 21:54:29 +01:00
|
|
|
|
Please see the file named
|
|
|
|
|
|
[`INSTALL.md`](https://github.com/rr-/szurubooru/blob/master/INSTALL.md).
|
2014-10-18 17:48:11 +02:00
|
|
|
|
|
|
|
|
|
|
## Bugs and feature requests
|
|
|
|
|
|
|
|
|
|
|
|
All bugs and suggestions should be reported as issues on the [Github
|
|
|
|
|
|
repository page](https://github.com/rr-/szurubooru/issues). 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.
|
2016-03-08 21:54:29 +01:00
|
|
|
|
4. If you're filing a feature request, provide examples - what might be
|
|
|
|
|
|
obvious to you, might not be so obvious to the developers.
|
2014-10-18 17:48:11 +02:00
|
|
|
|
|
|
|
|
|
|
## 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.
|
2016-03-08 21:54:29 +01:00
|
|
|
|
- Before starting, see
|
|
|
|
|
|
[`INSTALL.md`](https://github.com/rr-/szurubooru/blob/master/INSTALL.md).
|
2014-10-18 20:05:45 +02:00
|
|
|
|
- Use `grunt` to do automatic tasks like minifying Javascript files or running
|
2014-10-18 17:48:11 +02:00
|
|
|
|
tests. Run `grunt --help` to see full list of available tasks.
|
|
|
|
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
|
2016-03-08 21:54:29 +01:00
|
|
|
|
`szurubooru` from version 0.9+ uses REST API. Currently there is no formal
|
2014-10-18 20:05:45 +02:00
|
|
|
|
documentation; source code behind REST layer lies in `src/Controllers/`
|
2014-10-18 17:48:11 +02:00
|
|
|
|
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:
|
2016-03-08 21:54:29 +01:00
|
|
|
|
1. Send user credentials to `/auth`. You'll receive authentication token in
|
2014-10-18 17:48:11 +02:00
|
|
|
|
return.
|
2016-03-08 21:54:29 +01:00
|
|
|
|
2. Send this token in X-Authorization-Token header on subsequent requests.
|
2014-10-18 17:48:11 +02:00
|
|
|
|
|
|
|
|
|
|
Developers reserve right to change API at any time with neither prior notice
|
|
|
|
|
|
nor keeping backwards compatibility.
|
