From a6f35e11a75a9c84d347fb28828639e855115b10 Mon Sep 17 00:00:00 2001
From: Adam Parak <xparak1@fi.muni.cz>
Date: Tue, 28 Nov 2023 10:58:15 +0100
Subject: [PATCH] update README

---
 README.md | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b97d98a89..a403115a4 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,14 @@
 # Frontend (React)
 
-Work in progress reimplementation of INJECT Frontend from Angular (formerly TTX) to React.
+Monorepo of INJECT Frontend
+
+Subrepos:
+
+- frontend - Main repository hosting Vite-related code, main components specific to INJECT Frontend (sans Dashboard and soon Exercise Panel)
+- graphql - Library for the communication with the GraphQL-based backend. Library is specifically made to easen development of GraphQL centric code to ensure higher consistency of queries.
+- shared - Shared Library between all parts of the project containing functional and templating components
+- tests - Service repo for testing typescript functions handling some algorithmic things
+- backend - Submodule to an actually supported backend
 
 ## How to run
 
@@ -24,6 +32,13 @@ poetry run python manage.py runserver
 
 # then after running backend, run frontend dev
 yarn develop
+
+# if building
+
+# this step is mandatory, it compiles `graphql` and `shared` library
+yarn prebuild
+# this builds the `dist/` artifact from `frontend` repo.
+yarn build
 ```
 
 ## Project QC Features
@@ -38,4 +53,5 @@ The repo is littered with various README.md and GUIDELINES.md files that dictate
 - Generouted (allows for easier creation of router configuration)
 - GraphQL Codegen (allows for automatic typing of GraphQL queries)
 - PostCSS (increases compatiblity of CSS styling)
-- BlueprintJS (for UI)
\ No newline at end of file
+- BlueprintJS (for UI)
+- emotion CSS (for CSS-in-JS and type control)
\ No newline at end of file
-- 
GitLab