ulysia/szurubooru
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: formalize README

Browse source
This commit is contained in:
rr- 2016-03-31 23:40:36 +02:00
parent da3faa556f
commit 7e26fc87ce
1 changed files with 18 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -1,23 +1,19 @@
This is rewrite of `szurubooru` 0.9.x that intends to
This is rewrite of [`szurubooru` 0.9.x](https://github.com/rr-/szurubooru) that
intends to:
- Improve user experience within frontend. No more vertical user list. Better
upload form, larger thumbnails, make top navigation stay out of user way.
Maybe other goodies!
- Finally define sane REST API (with no bullshit such as SQL queries, request
timings or exception stack traces this time)
- Simplify registration - user registers, and they're able to post. No
activation e-mails, no nothing (email's going to be used **ONLY** for
password reminders, yes, *not even* for confirmation). Note that you will
have control over permissions, user ranks and the default user rank, so you
might be able to setup a system where user needs to be approved by mod to
join the community.
- Maybe simplify permission system
- Ditch PHP in favor of something more serious (python 3.5)
- Ditch in-house JS monstrosities in favor of something more serious (I've got
EmberJS on my radar)
- Replace dependencies such as composer, npm, grunt, and all that crap with
just python, and a few pip packages
- Simplify hosting: offer simple self hosted app combinable with reverse proxies
- Replace MySQL (/ MariaDB) with Postgres
- Less god damn code! 24KSLOC? For a thing this simple? The goal is to fit
within 15KSLOC. Let's see if I can accomplish this.
- Improve user experience: better upload form, larger thumbnails, make top
navigation stay out of user way. Maybe other goodies!
- Finally define sane REST API without unnecessary blobs and with proper
documentation.
- Simplify registration - user registers, and they're able to post. (You'll
still be able to make it kind of invite-only via default permissions.)
- Replace PHP with Python 3.5.
- Replace prior JS mess with proper MVC.
- Replace MySQL (MariaDB) with Postgres.
- Replace `composer`, `npm`, `mod_rewrite` (=Apache), `imagick`, `pdo_mysql`
with just `pip` and `npm` (+ sandboxed dependencies).
- Replace `grunt` with `npm` scripts.
- Make hosting more flexible: offer simple self hosted app that can be combined
with any reverse proxy.
- Reduce codebase size - the original szurubooru was at 30KSLOC (`git
line-summary`), let's see how much this can be brought down.