From 18c8aac98aefc2805a181d89b1de6a46def1c8b7 Mon Sep 17 00:00:00 2001 From: leonardo <leomilho@gmail.com> Date: Thu, 6 Apr 2023 15:28:50 +0200 Subject: [PATCH] build(docs): update README.md to correspond to the new workspace process --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 718a593ae..7ddbb344e 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ ## Preparing to Run Locally -Be sure that you have node.js and pnpm installed. Please use pnpm for building and running the scripts of package.json. +Be sure that you have node.js (v18 or up) and pnpm installed. Please use pnpm for building and running the scripts of package.json. Due to the way auth works (using a sameSite cookie), the procedure for running locally is a little different than usual. These steps will only have to be done, after that everything should 'just' work. ### MacOS / Linux @@ -27,8 +27,22 @@ Due to the way auth works (using a sameSite cookie), the procedure for running l ## Running Locally -To run the application using SSL (with these keys) simply run `nx run web-graphpolaris:dev`, or `pnpm nx run web-graphpolaris:dev` if `nx` is not installed globally. This should open a window to `https://local.datastrophe.science.uu.nl:4200/` automatically. +### Install -## Running Storybook.js +First run `pnpm i` on the root of the workspace to install all dependencies. It will create a node_module folder in the root of the workspace as well as one for each app/library within it. -To run the dev storybook (implementing visualizations) simply run `nx run web-graphpolaris:storybook`, or `pnpm nx run web-graphpolaris:storybook` if `nx` is not installed globally. +If you need to install a new dependency or upgrade an existing one, do so in the respective package.json and rerun `pnpm i` in the root of the workspace. If you find any issues, feel free to delete the node_modules folder from the workspace root and from the app/lib which you are changing the dependency and rerun the `pnpm i` command from the root of the workspace. Most issues are solved by then. + +### Commands + +You can run pnpm commands (see available ones in packages.json) from the root of the workspace, which will trigger turborepo to run it in all libraries and apps of the workspace. You can run `pnpm test` or `pnpm lint` this way to test or lint the entire workspace. + +You can also go into a specific lib/app and run pnpm commands from there to scope the task to only that part of the workspace. + +### Dev server + +To run the application using SSL (with these keys) simply run `pnpm dev` from the workspace root. + +### Running Storybook.js + +To run the dev storybook (implementing visualizations) simply run `pnpm sb` and once it is running, ctrl-click the link what appears in the terminal. -- GitLab