From 7e0bb262c5dd195f1575c01079e0f2808ade59f9 Mon Sep 17 00:00:00 2001 From: ioedeveloper Date: Thu, 19 Aug 2021 11:09:33 +0100 Subject: [PATCH] Added instructions for creating react apps and components --- libs/remix-ui/README.md | 30 ++++++++++++++++++++++++++---- 1 file changed, 26 insertions(+), 4 deletions(-) diff --git a/libs/remix-ui/README.md b/libs/remix-ui/README.md index 4d0a2662ba..7bb33ea706 100644 --- a/libs/remix-ui/README.md +++ b/libs/remix-ui/README.md @@ -2,12 +2,34 @@ This library was generated with [Nx](https://nx.dev). -## Steps To Generate React Lib +## Pre-requisite - Install **NxConsole** vscose extension +## Steps To Generate React App +- Open **NxConsole** extension +- Click generate option +- Select **@nrwl/react - application** +- Enter the name of the application +- Set **e2eTestRunner** to **none**. (This is because we run e2e tests with nightwatch) +- Set **unitTestRunner** to **none**. +- Click the run button in the top right corner of the generate page. +- Your react application should be created in **{root}/apps** directory. +## Steps To Generate React Lib - Open **NxConsole** extension - Click generate option -- Select **@nrwl/react -Library** -- Enter library name +- Select **@nrwl/react - library** +- Enter the name of the library - Set **directory** to **remix-ui** - Set **importPath** to **@remix-ui/{library-name}** -- Click the run button in the top right corner of the generate page. \ No newline at end of file +- Set **unitTestRunner** to **none**. +- Click the run button in the top right corner of the generate page. +- Your react library should be created on **{root}/libs/remix-ui** directory. + +## Steps To Generate React Component +- Open **NxConsole** extension +- Click generate option +- Select **@nrwl/react - component** +- Enter the name of the component +- Select the name of the project/library that uses the component. (e.g TreeView library) +- Set component directory if needed. +- Click the run button in the top right corner of the generate page. +- Your react component should be created with the project/library name specified. \ No newline at end of file