From f609adfb0cf4e688f321a7cd6493371260c2a1c6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D5=A1=C9=A8=D5=BC=C9=A2=D3=84=D5=A1=D6=85=D5=BC=C9=A2?= Date: Fri, 13 Oct 2023 23:26:02 +0800 Subject: [PATCH] fix(docs): install command - closes: #6686 - closes: #6687 --- .../050.engineering/030.development-setup.md | 51 +++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 packages/noco-docs/docs/050.engineering/030.development-setup.md diff --git a/packages/noco-docs/docs/050.engineering/030.development-setup.md b/packages/noco-docs/docs/050.engineering/030.development-setup.md new file mode 100644 index 0000000000..697a66cdad --- /dev/null +++ b/packages/noco-docs/docs/050.engineering/030.development-setup.md @@ -0,0 +1,51 @@ +--- +title: "Development Setup" +description: "How to set-up your development environment" +--- + +## Clone the repo + +```bash +git clone https://github.com/nocodb/nocodb +# change directory to the project root +cd nocodb +``` + +## Install dependencies + +```bash +# run from the project root +# this command will install the dependencies including sdk build +pnpm bootstrap +``` + +## Start Frontend + +```bash +# run from the project root +pnpm start:frontend +# runs on port 3000 +``` + +## Start Backend + +```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. + +## Enabling CI-CD for Draft PR + +CI-CD will be triggered on moving a PR from draft state to `Ready for review` state & on pushing changes to `Develop`. To verify CI-CD before requesting for review, add label `trigger-CI` on Draft PR. + +## Accessing CI-CD Failure Screenshots + +For Playwright tests, screenshots are captured on the tests. These will provide vital clues for debugging possible issues observed in CI-CD. To access screenshots, Open link associated with CI-CD run & click on `Artifacts` + +![Screenshot 2022-09-29 at 12 43 37 PM](https://user-images.githubusercontent.com/86527202/192965070-dc04b952-70fb-4197-b4bd-ca7eda066e60.png) + + +