summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYorhel <git@yorhel.nl>2019-09-25 18:37:29 +0200
committerYorhel <git@yorhel.nl>2019-09-25 18:49:19 +0200
commitd735e66d7d9b2d8c9a965ec96753864ff8c306c2 (patch)
treece0214b9e3cc819252b9192e7518f7768e568c77 /README.md
parentc7642c03d99ed0255614a43fb82e55a1dde66753 (diff)
v2rw: Add Elm & db_edit framework + Convert doc page editing
Most of this is copied from v3. I did improve on a few aspects: - db_edit() and db_entry() use VNDB::Schema rather than dynamically querying the DB. This has the minor advantage of a faster startup. - The Elm code generator now writes to multiple files, this avoids the namespace pollution seen in v3's Lib.Gen and makes the dependency graph a bit more lean (i.e. faster incremental builds). - The Elm code generator doesn't update the timestamp of files that haven't been modified. This also speeds up incremental builds, the elm compiler can now skip rebuilding unmodified files. - The Elm API response generator code now uses plain functions rather than code references and all possible responses are now defined in Elm.pm. Turns out most API responses were used from more than a single place, so it makes sense to have them centrally defined. The doc page preview function is also much nicer; I'd like to apply this to all BBCode textareas as well. (Elm.pm itself is ugly as hell though. And we will prolly need some HTML form generation functions in Elm to make that part less verbose)
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/README.md b/README.md
index af86396d..69219a70 100644
--- a/README.md
+++ b/README.md
@@ -136,13 +136,14 @@ has `util/vndb.pl` as entry point. Front-end assets are in `data/js/`,
**Version 2-rw**
-This is a (newly started) backend rewrite of version 2. It lives in
-`lib/VNWeb/`. Individual parts of the website are gradually being moved into
-this new coding style and structure. Version 2 and 2-rw run side-by-side in the
-same process and share a common route table and database connection, so the
-entry point is still `util/vndb.pl`. The primary goal of this rewrite is to
-make use of the clearer version 3 structure and to slowly migrate the brittle
-frontend Javascript parts to Elm and JSON APIs.
+This is a (recently started) backend rewrite of version 2. It lives in
+`lib/VNWeb/` with Elm and Javascript code in `elm/`. Individual parts of the
+website are gradually being moved into this new coding style and structure.
+Version 2 and 2-rw run side-by-side in the same process and share a common
+route table and database connection, so the entry point is still
+`util/vndb.pl`. The primary goal of this rewrite is to make use of the clearer
+version 3 structure and to slowly migrate the brittle frontend Javascript parts
+to Elm and JSON APIs.
**Version 3**