mirror of https://github.com/nocodb/nocodb
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
51 lines
1.2 KiB
51 lines
1.2 KiB
1 year ago
|
---
|
||
|
|
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
|
||
|
|
pnpm i
|
||
|
|
```
|
||
|
|
|
||
|
|
## 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`
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|