Browse Source

fix(docs): install command

- closes: #6686
- closes: #6687
pull/6690/head
աɨռɢӄաօռɢ 1 year ago
parent
commit
f609adfb0c
  1. 51
      packages/noco-docs/docs/050.engineering/030.development-setup.md

51
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)
Loading…
Cancel
Save