From 7bef31e36440afe48e9ed6d4076b63d24bc01de5 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Mon, 28 Aug 2023 16:01:28 +0800 Subject: [PATCH] docs: update content related to pnpm --- .../020.getting-started/010.installation.md | 6 +-- .../050.engineering/030.development-setup.md | 38 +++++++++---------- .../docs/050.engineering/040.unit-testing.md | 4 +- .../docs/050.engineering/050.playwright.md | 4 +- packages/noco-docs/docs/060.FAQs.md | 8 ++-- .../050.engineering/030.development-setup.md | 35 +++++++++-------- 6 files changed, 48 insertions(+), 47 deletions(-) diff --git a/packages/noco-docs/docs/020.getting-started/010.installation.md b/packages/noco-docs/docs/020.getting-started/010.installation.md index 6411993a39..0e01f27bef 100644 --- a/packages/noco-docs/docs/020.getting-started/010.installation.md +++ b/packages/noco-docs/docs/020.getting-started/010.installation.md @@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem'; Simple installation - takes about three minutes! ## Prerequisites -- [Docker](https://www.docker.com/get-started) or [Node.js](https://nodejs.org/en/download) ( > v16.x ) +- [Docker](https://www.docker.com/get-started) or [Node.js](https://nodejs.org/en/download) ( > v18.x ) ## Quick try @@ -211,8 +211,8 @@ We provide a simple NodeJS Application for getting started. ```bash git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed -pnpm install -pnpm start +npm install +npm start ``` diff --git a/packages/noco-docs/docs/050.engineering/030.development-setup.md b/packages/noco-docs/docs/050.engineering/030.development-setup.md index eda6c2985b..194fa79a8d 100644 --- a/packages/noco-docs/docs/050.engineering/030.development-setup.md +++ b/packages/noco-docs/docs/050.engineering/030.development-setup.md @@ -4,36 +4,34 @@ description: "How to set-up your development environment" --- ## Clone the repo -``` + +```bash git clone https://github.com/nocodb/nocodb -cd nocodb/packages +# change directory to the project root +cd nocodb ``` -## Build SDK +## Install dependencies -``` -# build nocodb-sdk -cd nocodb-sdk -npm install -npm run build +```bash +# run from the project root +pnpm bootstrap ``` -## Build Backend +## Start Frontend -``` -# build backend - runs on port 8080 -cd ../nocodb -npm install -npm run watch:run +```bash +# run from the project root +pnpm start:frontend +# runs on port 3000 ``` -## Build Frontend +## Start Backend -``` -# build frontend - runs on port 3000 -cd ../nc-gui -npm install -npm run dev +```bash +# run from the project root +pnpm start:backend +# runs on port 8080 ``` Any changes made to frontend and backend will be automatically reflected in the browser. diff --git a/packages/noco-docs/docs/050.engineering/040.unit-testing.md b/packages/noco-docs/docs/050.engineering/040.unit-testing.md index 0550bf0415..bc8e11da58 100644 --- a/packages/noco-docs/docs/050.engineering/040.unit-testing.md +++ b/packages/noco-docs/docs/050.engineering/040.unit-testing.md @@ -16,9 +16,7 @@ description: "Overview to Unit Testing" ### Setup ```bash -cd packages/nocodb - -pnpm install +pnpm --filter=-nocodb install # add a .env file cp tests/unit/.env.sample tests/unit/.env diff --git a/packages/noco-docs/docs/050.engineering/050.playwright.md b/packages/noco-docs/docs/050.engineering/050.playwright.md index 55590e98c1..02fe7dcd6d 100644 --- a/packages/noco-docs/docs/050.engineering/050.playwright.md +++ b/packages/noco-docs/docs/050.engineering/050.playwright.md @@ -7,10 +7,10 @@ description: "Overview to playwright based e2e tests" All the tests reside in `tests/playwright` folder. -Make sure to install the dependencies(in the playwright folder): +Make sure to install the dependencies (in the playwright folder): ```bash -pnpm install +pnpm --filter=playwright install pnpm exec playwright install --with-deps chromium ``` diff --git a/packages/noco-docs/docs/060.FAQs.md b/packages/noco-docs/docs/060.FAQs.md index 3e86f1a81c..4e52265d4d 100644 --- a/packages/noco-docs/docs/060.FAQs.md +++ b/packages/noco-docs/docs/060.FAQs.md @@ -25,12 +25,12 @@ description: 'General FAQs' You should see the similar result as below. ``` -Node: **v16.14.0** +Node: **v18.16.4** Arch: **arm64** -Platform: **darwin** -Docker: **false** +Platform: **linux** +Docker: **true** RootDB: **sqlite3** -PackageVersion: **0.109.7** +PackageVersion: **0.111.0** ``` ## What is available in free version ? diff --git a/packages/noco-docs/versioned_docs/version-0.109.7/050.engineering/030.development-setup.md b/packages/noco-docs/versioned_docs/version-0.109.7/050.engineering/030.development-setup.md index e054598435..b7cda75e1a 100644 --- a/packages/noco-docs/versioned_docs/version-0.109.7/050.engineering/030.development-setup.md +++ b/packages/noco-docs/versioned_docs/version-0.109.7/050.engineering/030.development-setup.md @@ -4,30 +4,36 @@ description: "How to set-up your development environment" --- ## Clone the repo - -```bash +``` git clone https://github.com/nocodb/nocodb +cd nocodb/packages ``` -## Install dependencies +## Build SDK -```bash -# run from the project root -pnpm bootstrap +``` +# build nocodb-sdk +cd nocodb-sdk +npm install +npm run build ``` -## Start Frontend +## Build Backend -```bash -# run from the project root -pnpm start:frontend +``` +# build backend - runs on port 8080 +cd ../nocodb +npm install +npm run watch:run ``` -## Start Backend +## Build Frontend -```bash -# run from the project root -pnpm start:backend +``` +# build frontend - runs on port 3000 +cd ../nc-gui +npm install +npm run dev ``` Any changes made to frontend and backend will be automatically reflected in the browser. @@ -52,4 +58,3 @@ Double click twice on empty space between `View list` & `Share` button to the le ![Screenshot 2023-05-23 at 8 35 14 PM](https://github.com/nocodb/nocodb/assets/86527202/fe2765fa-5796-4d26-8c12-e71b8226872e) -