lesderid
/
luckybooru_info
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update goals and dependencies, and add deployment options

This commit is contained in:
Les De Ridder 2020-02-29 23:53:59 +01:00
parent 09e5702f5a
commit 81114e5c8f
2 changed files with 54 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
index.html
View File

@ -22,8 +22,10 @@
principles</a>
</li>
<li>
<a href="#Major-technologies-used">Major technologies
used</a>
<a href="#Dependencies">Dependencies</a>
</li>
<li>
<a href="#Deployment-options">Deployment options</a>
</li>
<li>
<a href="#Database-schema-WIP">Database schema (WIP)</a>
@ -48,10 +50,15 @@
plaintext, Markdown)</li>
<li>Full support for running in a cluster with live
scaling</li>
<li>All major features should work with <em>noscript</em></li>
<li>RESTful API</li>
<li>All major features should work with no-JS/<em>noscript</em>
and text browsers</li>
<li>Fast on the server-side and on the client-side (no Python
or Java)</li>
<li>High configurability (user roles, analytics, danbooru-like
premium account tiers)</li>
<li>RESTful API with JSON output</li>
</ul>
<h2 id="Major-technologies-used">Major technologies used</h2>
<h2 id="Dependencies">Dependencies</h2>
<ul>
<li>
<a href="https://crystal-lang.org/">Crystal</a>
@ -59,6 +66,30 @@
<li>
<a href="https://luckyframework.org">Lucky</a>
</li>
<li>
<a href="https://www.postgresql.org/">PostgreSQL</a>
</li>
<li>
<a href="https://github.com/getsentry/sentry">Sentry</a>
(with <a href=
"https://github.com/Sija/raven.cr">raven.cr</a>)
</li>
<li>
<a href="https://github.com/valeriansaliou/sonic">Sonic</a>
(?)
</li>
</ul>
<h2 id="Deployment-options">Deployment options</h2>
<p>We aim to support a variety of deployment options, including
the following:</p>
<ul>
<li>Application: Kubernetes (hosted, private cluster), manual
Docker deployment, traditional server</li>
<li>Database: PostgreSQL, <a href=
"https://aws.amazon.com/rds/postgresql/">RDS for
PostgreSQL</a>, <a href=
"https://www.cockroachlabs.com/product/">CockroachDB</a>
</li>
</ul>
<h2 id="Database-schema-WIP">Database schema (WIP)</h2>
<p><img src="schema.png" alt="(database schema image)"></p>
@ -70,6 +101,7 @@
</li>
</ul>
<p>All repos are licensed under the <a href=
"LICENSE.html">University of Illinois/NCSA license</a>.</p>
"LICENSE.html">University of Illinois/NCSA Open Source
License</a>.</p>
</body>
</html>

20
source/index.md
View File

@ -11,13 +11,25 @@ luckybooru is in the early design stage.
* Feature parity with danbooru
* Support for various types of media (images, audio, videos, plaintext, Markdown)
* Full support for running in a cluster with live scaling
* All major features should work with *noscript*
* RESTful API
* All major features should work with no-JS/*noscript* and text browsers
* Fast on the server-side and on the client-side (no Python or Java)
* High configurability (user roles, analytics, danbooru-like premium account tiers)
* RESTful API with JSON output
## Major technologies used
## Dependencies
* [Crystal](https://crystal-lang.org/)
* [Lucky](https://luckyframework.org)
* [PostgreSQL](https://www.postgresql.org/)
* [Sentry](https://github.com/getsentry/sentry) (with [raven.cr](https://github.com/Sija/raven.cr))
* [Sonic](https://github.com/valeriansaliou/sonic) (?)
## Deployment options
We aim to support a variety of deployment options, including the following:
* Application: Kubernetes (hosted, private cluster), manual Docker deployment, traditional server
* Database: PostgreSQL, [RDS for PostgreSQL](https://aws.amazon.com/rds/postgresql/), [CockroachDB](https://www.cockroachlabs.com/product/)
## Database schema (WIP)
@ -28,4 +40,4 @@ luckybooru is in the early design stage.
* Main repo: *to be created*
* This page: [luckybooru_info](https://git.fuwafuwa.moe/lesderid/luckybooru_info)
All repos are licensed under the [University of Illinois/NCSA license](LICENSE.html).
All repos are licensed under the [University of Illinois/NCSA Open Source License](LICENSE.html).