🧑‍💻 Web Codebase

License · Structure · Projects

---

🤷🏼‍♂️ How to

Setup Monorepo and dependencies

make install

Test code

make test

Build code

make build

For this to work, you need to have pnpm installed.

👷🏻 Frontend Structure

Apps are divided into 4 library-types. These apps are not developed like monoliths but will be bundled together for ease of deployment.

All these libraries are scoped to the feature they belong to unless the path is prefixed with shared (ex libs/shared/ui) or the project is in the project-root (ex libs/project-name/not-scoped-to-feature-lib). These library types are:

An example:

libs:
  project-name:
    auth:
      feature:
      ui:
      hooks:
    theme:
    types:

Projects with a ? are not required.

ui	data-access?
This is a library which only contains **dumb** components for other libraries to use.	This library holds all api-calls to other sources/servers. This also contains all state-management stores.
theme	hooks
This is where the theme is stored. Its used only by shell libraries because they only needs to be registered once.	This is where all the hooks are. They can only depend on data-access libraries.
types?	feature
This is where all the typescript types are. They are buildable libraries because nx requires them to be if other buildable libraries depend on this.	This is where all the routes are. Its also where most of the libraries are consumed. This can consume all libraries except other features.

---

🔧 Projects

🕶️ Alias	🏷️ Name
Apps		⚡ Done	🚧 In Development	🤔 Planning to build
Thunder	Movie Reviewer App		👷🏾
Honey	Subscription Handler		👷🏾
Butler	New tab extention			🚦
About	Portfolio		👷🏾
Club	Dashboard for Clubguard		👷🏾
Packages		⚡ Done	🚧 In Development	🤔 Planning to build
core-ui	The core ui used in Web repo		👷🏾
hooks	General react-hooks		👷🏾

---

📜 Licensing

This repository is under the MIT license.

---