aelve/guide
1
1
Fork 0
mirror of https://github.com/aelve/guide.git synced 2024-11-22 11:33:34 +03:00
Code Issues Projects Releases Wiki Activity

Update the readme

Browse Source
This commit is contained in:
Artyom Kazak 2018-09-24 00:03:28 +02:00
parent 2d52116e6d
commit 8a756ea059
1 changed files with 1 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -46,6 +46,7 @@ $ stack test
* `scripts` – some scripts used by automatic testing
* `favicon` – code used to generate a favicon
* `guidejs` – client side JavaScript
* `front` – the new frontend, written in Vue.js
### Frontend
@ -69,36 +70,3 @@ When you see something like
~~~
it means that there's an extensive comment somewhere else in the code, which you can find by grepping for `Note [acid-state]`. This convention was stolen from GHC. If you know some plugin for Emacs that would help with jumping to comments (even if those comments would have to be formatted differently), let me know.
### Main modules
THIS SECTION IS OUTDATED
There are 4 main modules – `Guide.hs`, `JS.hs`, `View.hs`, and `Types.hs`.
`Guide.hs` contains:
* handlers for GET/POST requests (`renderMethods`, `setMethods`, etc)
* feed generation (`itemToFeedEntry`)
* some utility functions (`undoEdit`, `lucidWithConfig`, `createCheckpoint'`)
* the `main` function, which starts the server
`JS.hs` contains all Javascript that is used in pages. The way it works is tricky: each Javascript function is overloaded in such a way that it can generate either a function call or a function definition. `allJSFunctions`, exported by `JS.hs`, is made by producing definitions from all functions in the module and then concatenating them; later `allJSFunction` is served by the server as `/js.js`. When you see something like `JS.foo (a, b, c)` in Haskell code, a call to `foo` is being generated (and `foo` can be found in `JS.hs`).
`View.hs` contains HTML rendering code. (It's much uglier than using templates, and we should switch to templates one day. Actually, maybe we should even switch to Node.js or Elm from Haskell.)
`Types.hs` contains almost all types used in code elsewhere – `Item`, `Category`, and so on. `GlobalState` is a type for, well, the whole database used by the site. All content, all edits, and all analytics data (i.e. users' IPs, etc) are stored there. The data is held in memory, and acid-state makes sure that data on hard drive is kept in sync with it. For a more detailed explanation, see `Note [acid-state]`.
Currently changing database schema is somewhat painful; to see how exactly painful it is, look at `Note [extending types]`. Not painful enough to never touch it again, sure, but still kinda annoying. Making it easier is possible, but for that we'd need a different `acid-state` or a real database.
### Other modules
`Markdown.hs` contains functions for rendering Markdown. There are special types for Markdown as well, coupling rendered Markdown, its text representation, and its parse tree.
`Merge.hs` contains an algorithm for merging edits – if you are editing a description of an item and someone else is editing the same description, upon submitting your edit you'll get a popup showing both versions and a merged version.
`Cache.hs` provides some helpers for caching pages. (A cache is a global variable holding a map from cache keys to rendered HTML.)
`Config.hs` has a config type and functions for reading/writing said config.
`Utils.hs` is just that – utility functions.