docs: clarify architecture

This commit is contained in:
steve-chavez
2024-05-24 18:05:45 -05:00
committed by Steve Chavez
parent 30ca64d849
commit 1c371d7340
+12 -5
View File
@@ -13,13 +13,20 @@ Code Map
This section talks briefly about various important modules.
The starting points of the program are:
Main
----
- `Main.hs <https://github.com/PostgREST/postgrest/blob/main/main/Main.hs>`_
- `CLI.hs <https://github.com/PostgREST/postgrest/blob/main/src/PostgREST/CLI.hs>`_
- `App.hs <https://github.com/PostgREST/postgrest/blob/main/src/PostgREST/App.hs>`_
The starting point of the program is `Main.hs <https://github.com/PostgREST/postgrest/blob/main/main/Main.hs>`_.
``App.hs`` is then in charge of composing the different modules.
CLI
---
Main then calls `CLI.hs <https://github.com/PostgREST/postgrest/blob/main/src/PostgREST/CLI.hs>`_, which is in charge of :ref:`cli`.
App
---
`App.hs <https://github.com/PostgREST/postgrest/blob/main/src/PostgREST/App.hs>`_ is then in charge of composing the different modules.
Auth
----