diff --git a/README.md b/README.md index 54cc834d69..085601606c 100644 --- a/README.md +++ b/README.md @@ -85,8 +85,8 @@ We provide a simple NodeJS Application for getting started. ```bash git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed -npm install -npm start +pnpm install +pnpm start ``` ## Docker diff --git a/markdown/readme/languages/chinese.md b/markdown/readme/languages/chinese.md index b68232973c..86679b239f 100644 --- a/markdown/readme/languages/chinese.md +++ b/markdown/readme/languages/chinese.md @@ -50,8 +50,8 @@ npx create-nocodb-app ```bash git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed -npm install -npm start +pnpm install +pnpm start ``` ## Docker 部署 @@ -215,15 +215,15 @@ cd nocodb ```shell cd packages/nocodb-sdk -npm install -npm run build +pnpm install +pnpm run build ``` ## 本地运行后端 ```shell cd packages/nocodb -npm install -npm run watch:run +pnpm install +pnpm run watch:run # 在浏览器中打开 localhost:8080/dashboard ``` @@ -231,14 +231,14 @@ npm run watch:run ```shell cd packages/nc-gui -npm install -npm run dev +pnpm install +pnpm run dev # 在浏览器中打开 localhost:3000/dashboard ``` 修改代码后会自动重新启动。 -> nocodb/packages/nocodb 包括 nc-lib-gui,它是 npm 源中托管的 nc-gui 的预构建版本。如果您只想修改后端,则可以在本地启动后端后在浏览器中访问 localhost:8000/dashboard +> nocodb/packages/nocodb 包括 nc-lib-gui,它是 pnpm 源中托管的 nc-gui 的预构建版本。如果您只想修改后端,则可以在本地启动后端后在浏览器中访问 localhost:8000/dashboard # 贡献 diff --git a/markdown/readme/languages/dutch.md b/markdown/readme/languages/dutch.md index 445043774d..29269958ad 100644 --- a/markdown/readme/languages/dutch.md +++ b/markdown/readme/languages/dutch.md @@ -60,8 +60,8 @@ npx create-nocodb-app ``` git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed -npm install -npm start +pnpm install +pnpm start ``` ### GUI diff --git a/markdown/readme/languages/french.md b/markdown/readme/languages/french.md index 52036eaf49..ff1fcd3c8c 100644 --- a/markdown/readme/languages/french.md +++ b/markdown/readme/languages/french.md @@ -64,8 +64,8 @@ npx create-nocodb-app ``` git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed -npm install -npm start +pnpm install +pnpm start ``` ### GUI diff --git a/markdown/readme/languages/german.md b/markdown/readme/languages/german.md index 7707156fc9..7fd1de0e10 100644 --- a/markdown/readme/languages/german.md +++ b/markdown/readme/languages/german.md @@ -52,7 +52,7 @@ docker run -d --name nocodb -p 8080:8080 nocodb/nocodb:latest ### Verwenden von NPM ``` -npm install create-nocodb-app +pnpm install create-nocodb-app ``` ### Verwenden von NPX @@ -66,8 +66,8 @@ npx create-nocodb-app ``` git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed -npm install -npm start +pnpm install +pnpm start ``` ### GUI @@ -205,8 +205,8 @@ cd nocodb ```shell cd packages/nocodb -npm install -npm run watch:run +pnpm install +pnpm run watch:run # localhost:8080/dashboard im Browser aufrufen ``` @@ -214,14 +214,14 @@ npm run watch:run ```shell cd packages/nc-gui -npm install -npm run dev +pnpm install +pnpm run dev # localhost:3000/dashboard iM Browser aufrufen ``` Änderungen am Code starten automatisch neu. -> nocodb/packages/nocodb enthält nc-lib-gui, die entwickelte Version von nc-gui, die in der npm-Registry gehostet wird. Sie können localhost:8000/dashboard im Browser aufrufen, nachdem Sie das Backend lokal gestartet haben, wenn Sie nur das Backend ändern möchten. +> nocodb/packages/nocodb enthält nc-lib-gui, die entwickelte Version von nc-gui, die in der pnpm-Registry gehostet wird. Sie können localhost:8000/dashboard im Browser aufrufen, nachdem Sie das Backend lokal gestartet haben, wenn Sie nur das Backend ändern möchten. # Beiträge diff --git a/markdown/readme/languages/indonesian.md b/markdown/readme/languages/indonesian.md index a3fff11549..7930cce4cf 100644 --- a/markdown/readme/languages/indonesian.md +++ b/markdown/readme/languages/indonesian.md @@ -60,8 +60,8 @@ npx create-nocodb-app ``` git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed -npm install -npm start +pnpm install +pnpm start ``` ### GUI diff --git a/markdown/readme/languages/italian.md b/markdown/readme/languages/italian.md index bf53b18865..66d56fff40 100644 --- a/markdown/readme/languages/italian.md +++ b/markdown/readme/languages/italian.md @@ -60,8 +60,8 @@ npx create-nocodb-app ``` git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed -npm install -npm start +pnpm install +pnpm start ``` ### GUI diff --git a/markdown/readme/languages/japanese.md b/markdown/readme/languages/japanese.md index 3253f94d6d..b57cb1b4cd 100644 --- a/markdown/readme/languages/japanese.md +++ b/markdown/readme/languages/japanese.md @@ -60,8 +60,8 @@ npx create-nocodb-app ``` git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed -npm install -npm start +pnpm install +pnpm start ``` ### GUI diff --git a/markdown/readme/languages/korean.md b/markdown/readme/languages/korean.md index 0abf7ed054..01f0be7ba0 100644 --- a/markdown/readme/languages/korean.md +++ b/markdown/readme/languages/korean.md @@ -48,7 +48,7 @@ docker run -d --name nocodb -p 8080:8080 nocodb/nocodb:latest ``` docker run -d -p 8080:8080 --name nocodb -v "$(pwd)"/nocodb:/usr/app/data/ nocodb/nocodb: -### npm 사용 +### pnpm 사용 ``` npx create-nocodb-app @@ -59,8 +59,8 @@ npx create-nocodb-app ``` git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed -npm install -npm start +pnpm install +pnpm start ``` ### GUI diff --git a/markdown/readme/languages/portuguese.md b/markdown/readme/languages/portuguese.md index 77b2b69043..79e1caaf2f 100644 --- a/markdown/readme/languages/portuguese.md +++ b/markdown/readme/languages/portuguese.md @@ -49,7 +49,7 @@ docker run -d --name nocodb -p 8080:8080 nocodb/nocodb:latest docker run -d -p 8080:8080 --name nocodb -v "$(pwd)"/nocodb:/usr/app/data/ nocodb/nocodb:latest ``` -### Usando npm. +### Usando pnpm. ``` npx create-nocodb-app @@ -60,8 +60,8 @@ npx create-nocodb-app ``` git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed -npm install -npm start +pnpm install +pnpm start ``` ### GUI diff --git a/markdown/readme/languages/russian.md b/markdown/readme/languages/russian.md index cd7ada6be7..d155e03c1a 100644 --- a/markdown/readme/languages/russian.md +++ b/markdown/readme/languages/russian.md @@ -60,8 +60,8 @@ npx create-nocodb-app ``` git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed -npm install -npm start +pnpm install +pnpm start ``` ### GUI diff --git a/markdown/readme/languages/spanish.md b/markdown/readme/languages/spanish.md index b5ac72a6f4..9fcd681d23 100644 --- a/markdown/readme/languages/spanish.md +++ b/markdown/readme/languages/spanish.md @@ -49,7 +49,7 @@ docker run -d --name nocodb -p 8080:8080 nocodb/nocodb:latest docker run -d -p 8080:8080 --name nocodb -v "$(pwd)"/nocodb:/usr/app/data/ nocodb/nocodb:latest ``` -### Usando npm. +### Usando pnpm. ``` npx create-nocodb-app @@ -60,8 +60,8 @@ npx create-nocodb-app ``` git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed -npm install -npm start +pnpm install +pnpm start ``` ### GUI diff --git a/packages/noco-docs/content/en/developer-resources/sdk.md b/packages/noco-docs/content/en/developer-resources/sdk.md index fa4a94ab22..8adb5daf18 100644 --- a/packages/noco-docs/content/en/developer-resources/sdk.md +++ b/packages/noco-docs/content/en/developer-resources/sdk.md @@ -17,7 +17,7 @@ Note: The NocoDB SDK requires authorization token. If you haven't created one, p ### Install nocodb-sdk ```bash -npm i nocodb-sdk +pnpm i nocodb-sdk ``` ### Import Api diff --git a/packages/noco-docs/content/en/engineering/development-setup.md b/packages/noco-docs/content/en/engineering/development-setup.md index 1576ba471b..cb9dfda161 100644 --- a/packages/noco-docs/content/en/engineering/development-setup.md +++ b/packages/noco-docs/content/en/engineering/development-setup.md @@ -17,8 +17,8 @@ cd nocodb/packages ``` # build nocodb-sdk cd nocodb-sdk -npm install -npm run build +pnpm install +pnpm run build ``` ## Build Backend @@ -26,8 +26,8 @@ npm run build ``` # build backend - runs on port 8080 cd ../nocodb -npm install -npm run watch:run +pnpm install +pnpm run watch:run ``` ## Build Frontend @@ -35,8 +35,8 @@ npm run watch:run ``` # build frontend - runs on port 3000 cd ../nc-gui -npm install -npm run dev +pnpm install +pnpm run dev ``` Any changes made to frontend and backend will be automatically reflected in the browser. diff --git a/packages/noco-docs/content/en/engineering/playwright.md b/packages/noco-docs/content/en/engineering/playwright.md index 45d8eea8e8..1fd9370e99 100644 --- a/packages/noco-docs/content/en/engineering/playwright.md +++ b/packages/noco-docs/content/en/engineering/playwright.md @@ -13,7 +13,7 @@ All the tests reside in `tests/playwright` folder. Make sure to install the dependencies(in the playwright folder): ```bash -npm install +pnpm install npx playwright install chromium --with-deps ``` @@ -22,13 +22,13 @@ npx playwright install chromium --with-deps Start the backend test server (in `packages/nocodb` folder): ```bash -npm run watch:run:playwright +pnpm run watch:run:playwright ``` Start the frontend test server (in `packages/nc-gui` folder): ```bash -NUXT_PAGE_TRANSITION_DISABLE=true npm run dev +NUXT_PAGE_TRANSITION_DISABLE=true pnpm run dev ``` ### Running all tests @@ -38,13 +38,13 @@ For selecting db type, rename `.env.example` to `.env` and set `E2E_DEV_DB_TYPE` headless mode(without opening browser): ```bash -npm run test +pnpm run test ``` with browser: ```bash -npm run test:debug +pnpm run test:debug ```
@@ -73,7 +73,7 @@ test.only('should login', async ({ page }) => { ``` ```bash -npm run test +pnpm run test ``` ## Concepts @@ -221,4 +221,4 @@ async verifyFilter({ title }: { title: string }) { - Open `Summary` tab in the CI workflow in github actions. - Scroll down to `Artifacts` section. - Access reports which suffixed with the db type and shard number(corresponding to the CI workerflow name). i.e `playwright-report-mysql-2` is for `playwright-mysql-2` workflow. -- Download it and run `npm install -D @playwright/test && npx playwright show-report ./` inside the downloaded folder. +- Download it and run `pnpm install -D @playwright/test && npx playwright show-report ./` inside the downloaded folder. diff --git a/packages/noco-docs/content/en/engineering/unit-testing.md b/packages/noco-docs/content/en/engineering/unit-testing.md index ad9716903c..37082a0057 100644 --- a/packages/noco-docs/content/en/engineering/unit-testing.md +++ b/packages/noco-docs/content/en/engineering/unit-testing.md @@ -21,7 +21,7 @@ menuTitle: "Unit Testing" ```bash cd packages/nocodb -npm install +pnpm install # add a .env file cp tests/unit/.env.sample tests/unit/.env @@ -38,7 +38,7 @@ Configure the following variables ### Run Tests ``` bash -npm run test:unit +pnpm run test:unit ``` ### Folder Structure diff --git a/packages/noco-docs/content/en/getting-started/installation.md b/packages/noco-docs/content/en/getting-started/installation.md index f3fb00feab..ad1fbaefc5 100644 --- a/packages/noco-docs/content/en/getting-started/installation.md +++ b/packages/noco-docs/content/en/getting-started/installation.md @@ -201,8 +201,8 @@ We provide a simple NodeJS Application for getting started. ```bash git clone https://github.com/nocodb/nocodb-seed cd nocodb-seed -npm install -npm start +pnpm install +pnpm start ``` diff --git a/packages/noco-docs/content/en/getting-started/upgrading.md b/packages/noco-docs/content/en/getting-started/upgrading.md index 1eecf2bfd7..af08263124 100644 --- a/packages/noco-docs/content/en/getting-started/upgrading.md +++ b/packages/noco-docs/content/en/getting-started/upgrading.md @@ -57,12 +57,12 @@ From your root folder #### Uninstall NocoDB package ```bash -npm uninstall nocodb +pnpm uninstall nocodb ``` #### Install NocoDB package ```bash -npm install --save nocodb +pnpm install --save nocodb ``` ## Homebrew diff --git a/packages/nocodb/README.md b/packages/nocodb/README.md index 00a13b112a..f5aa86c5dc 100644 --- a/packages/nocodb/README.md +++ b/packages/nocodb/README.md @@ -29,33 +29,33 @@ ## Installation ```bash -$ npm install +$ pnpm install ``` ## Running the app ```bash # development -$ npm run start +$ pnpm run start # watch mode -$ npm run start:dev +$ pnpm run start:dev # production mode -$ npm run start:prod +$ pnpm run start:prod ``` ## Test ```bash # unit tests -$ npm run test +$ pnpm run test # e2e tests -$ npm run test:e2e +$ pnpm run test:e2e # test coverage -$ npm run test:cov +$ pnpm run test:cov ``` ## Support