Restructure Workspace

[ChristopherPHolder]

TL;DR;

Restructure workspace to improve architecture and readability.

Description

Currently the workspace is very badly structures, and has no documentation about the way things should be structures.

This MR will improve the general structure to reflect best practices. It will also add proper documentation into the readme and lint rules to prevent this issue from coming back.

References:

• NX Docs
• Greenforce Frontend Repo This is an example provided by Lars as a good structure.
• Code-Pushup CLI Repo

[ChristopherPHolder]

Generally speaking there are top level approaches to folder structures:

• apps/libs
• packages/tools

There is no right and wrong answer here but I agree with Edouard Bozon.

Using packages/tools will be used to provide better code colocation.

This is already partially implemented to the repo already. But is not properly implmented as currently many things are provided in the top level packages. This make it very hard to read and not easy to understand what is and project of its own and what actually belongs to another project.

For this reason we will reserve the top level to applications or packages and shared

packages
├──  api
├──  portal
├──  runner
└──  shared

runner
├──  e2e
├──  app-cli
├──  data-access-queue
├──  data-access-store
├──  feature-replay
├──  util-interfaces
└──  util-middleware