@equinor/echo-framework 0.13.2 → 0.14.0

package/README.md

@@ -1,11 +1,55 @@
 # EchoFramework
 
+This publishable library was generated with [Nx](https://nx.dev).
+
 Framework provides all the necessary components to put the echo web client together. It also provides modules and components for EchoWeb, mainly utilizing EchoCore.
 
-Check the docs for details:
-https://github.com/equinor/EchoFramework/blob/main/doc/echo-framework.md
+Check the [docs for details](doc/echo-framework.md).
+
+## How to develop EchoFramework
+
+How to develop EchoFramework in the new, monorepo structure?
+
+-   Use the dev branch as base branch for your features
+    -   Development work can be done now together with echopediaWeb, since they're in the same repo!
+-   Open PR, ask for review as before
+-   Merge feature branch into dev once PR is approved
+-   Do not run npm install in `libs/echo-framework`
+    -   Do that in the root folder: NX uses every dependency from the root for all libraries
+-   Do not add anything to `package.json` found in `echo-framework` library
+    -   For `echo-framework` NX generates the `package.json` on build partly based on the local `package.json`
+    -   All dependencies used during development will be taken from the root folder, based on the `package.json` found there
+-   Note: some initial peerDependencies have been added to the base `echo-framework` package.json
+    -   That's because instead of a fixed version we would like to define a version range.
+    -   In case of react: `"react": ">= 17.0.2"`
+    -   When `echo-framework`'s package.json is generated, these pre-defined versions will be used
+
+## How to make new release of echoFramework?
+
+-   Bump version in the package.json for `echoFramework` in libs/echo-framework in your PR
+-   Draft new release via the gitHub UI
+    -   Use the label `echo-framework@X.Y.Z` (where X, Y, Z stands for the latest version number) for the release, so the dedicated github action can publish it for you
+-   Once the release is published, a github action will pick it up and publish `echoFramework` for you to npm
+    -   It knows what to publish based on the release's `echo-framework` label
 
 ## EchoFramework UI components and tools
 
-Framework houses multiple tools for UI bars, panels and menu functionality that can be used in Web and modules. See more in docs:
-https://github.com/equinor/EchoFramework/blob/main/doc/echo-framework-ui.md
+Framework houses multiple tools for UI bars, panels and menu functionality that can be used in Web and modules. See more in the [related docs](./doc/echo-framework-ui.md).
+
+## Running unit tests
+
+Run `nx test echo-framework` to execute the unit tests via [Jest](https://jestjs.io).
+
+## Create build
+
+Run `npx nx run echo-framework:build` to create a build
+
+## Monorepo maintenance info
+
+Last time framework was synced, new code moved from the original repo:
+7th of August, 2023
+
+## Old repository of echoFramework
+
+Keeping it for historical reasons.
+https://github.com/equinor/EchoFramework