Browse Source

docs: update content related to pnpm

pull/5903/head
Wing-Kam Wong 12 months ago
parent
commit
7bef31e364
  1. 6
      packages/noco-docs/docs/020.getting-started/010.installation.md
  2. 38
      packages/noco-docs/docs/050.engineering/030.development-setup.md
  3. 4
      packages/noco-docs/docs/050.engineering/040.unit-testing.md
  4. 4
      packages/noco-docs/docs/050.engineering/050.playwright.md
  5. 8
      packages/noco-docs/docs/060.FAQs.md
  6. 35
      packages/noco-docs/versioned_docs/version-0.109.7/050.engineering/030.development-setup.md

6
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! Simple installation - takes about three minutes!
## Prerequisites ## 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 ## Quick try
@ -211,8 +211,8 @@ We provide a simple NodeJS Application for getting started.
```bash ```bash
git clone https://github.com/nocodb/nocodb-seed git clone https://github.com/nocodb/nocodb-seed
cd nocodb-seed cd nocodb-seed
pnpm install npm install
pnpm start npm start
``` ```

38
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 ## Clone the repo
```
```bash
git clone https://github.com/nocodb/nocodb git clone https://github.com/nocodb/nocodb
cd nocodb/packages # change directory to the project root
cd nocodb
``` ```
## Build SDK ## Install dependencies
``` ```bash
# build nocodb-sdk # run from the project root
cd nocodb-sdk pnpm bootstrap
npm install
npm run build
``` ```
## Build Backend ## Start Frontend
``` ```bash
# build backend - runs on port 8080 # run from the project root
cd ../nocodb pnpm start:frontend
npm install # runs on port 3000
npm run watch:run
``` ```
## Build Frontend ## Start Backend
``` ```bash
# build frontend - runs on port 3000 # run from the project root
cd ../nc-gui pnpm start:backend
npm install # runs on port 8080
npm run dev
``` ```
Any changes made to frontend and backend will be automatically reflected in the browser. Any changes made to frontend and backend will be automatically reflected in the browser.

4
packages/noco-docs/docs/050.engineering/040.unit-testing.md

@ -16,9 +16,7 @@ description: "Overview to Unit Testing"
### Setup ### Setup
```bash ```bash
cd packages/nocodb pnpm --filter=-nocodb install
pnpm install
# add a .env file # add a .env file
cp tests/unit/.env.sample tests/unit/.env cp tests/unit/.env.sample tests/unit/.env

4
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. 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 ```bash
pnpm install pnpm --filter=playwright install
pnpm exec playwright install --with-deps chromium pnpm exec playwright install --with-deps chromium
``` ```

8
packages/noco-docs/docs/060.FAQs.md

@ -25,12 +25,12 @@ description: 'General FAQs'
You should see the similar result as below. You should see the similar result as below.
``` ```
Node: **v16.14.0** Node: **v18.16.4**
Arch: **arm64** Arch: **arm64**
Platform: **darwin** Platform: **linux**
Docker: **false** Docker: **true**
RootDB: **sqlite3** RootDB: **sqlite3**
PackageVersion: **0.109.7** PackageVersion: **0.111.0**
``` ```
## What is available in free version ? ## What is available in free version ?

35
packages/noco-docs/versioned_docs/version-0.109.7/050.engineering/030.development-setup.md vendored

@ -4,30 +4,36 @@ description: "How to set-up your development environment"
--- ---
## Clone the repo ## Clone the repo
```
```bash
git clone https://github.com/nocodb/nocodb git clone https://github.com/nocodb/nocodb
cd nocodb/packages
``` ```
## Install dependencies ## Build SDK
```bash ```
# run from the project root # build nocodb-sdk
pnpm bootstrap cd nocodb-sdk
npm install
npm run build
``` ```
## Start Frontend ## Build Backend
```bash ```
# run from the project root # build backend - runs on port 8080
pnpm start:frontend cd ../nocodb
npm install
npm run watch:run
``` ```
## Start Backend ## Build Frontend
```bash ```
# run from the project root # build frontend - runs on port 3000
pnpm start:backend cd ../nc-gui
npm install
npm run dev
``` ```
Any changes made to frontend and backend will be automatically reflected in the browser. 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) ![Screenshot 2023-05-23 at 8 35 14 PM](https://github.com/nocodb/nocodb/assets/86527202/fe2765fa-5796-4d26-8c12-e71b8226872e)

Loading…
Cancel
Save