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.
62 lines
1.5 KiB
62 lines
1.5 KiB
2 years ago
|
---
|
||
2 years ago
|
title: "Development Setup"
|
||
2 years ago
|
description: "How to set-up your development environment"
|
||
2 years ago
|
---
|
||
|
|
||
2 years ago
|
## Clone the repo
|
||
2 years ago
|
```
|
||
|
git clone https://github.com/nocodb/nocodb
|
||
|
cd nocodb/packages
|
||
|
```
|
||
|
|
||
2 years ago
|
## Build SDK
|
||
2 years ago
|
|
||
2 years ago
|
```
|
||
|
# build nocodb-sdk
|
||
|
cd nocodb-sdk
|
||
|
npm install
|
||
|
npm run build
|
||
|
```
|
||
|
|
||
2 years ago
|
## Build Backend
|
||
2 years ago
|
|
||
2 years ago
|
```
|
||
|
# build backend - runs on port 8080
|
||
|
cd ../nocodb
|
||
|
npm install
|
||
|
npm run watch:run
|
||
|
```
|
||
|
|
||
2 years ago
|
## Build Frontend
|
||
2 years ago
|
|
||
2 years ago
|
```
|
||
|
# build frontend - runs on port 3000
|
||
|
cd ../nc-gui
|
||
|
npm install
|
||
|
npm run dev
|
||
|
```
|
||
|
|
||
2 years ago
|
Any changes made to frontend and backend will be automatically reflected in the browser.
|
||
|
|
||
2 years ago
|
## Enabling CI-CD for Draft PR
|
||
|
|
||
2 years ago
|
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.
|
||
|
|
||
2 years ago
|
## 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`
|
||
2 years ago
|
|
||
|
![Screenshot 2022-09-29 at 12 43 37 PM](https://user-images.githubusercontent.com/86527202/192965070-dc04b952-70fb-4197-b4bd-ca7eda066e60.png)
|
||
|
|
||
2 years ago
|
## Accessing 'Easter egg' menu
|
||
|
|
||
|
Double click twice on empty space between `View list` & `Share` button to the left top of Grid view; following options become accessible
|
||
|
1. Export Cache
|
||
|
2. Delete Cache
|
||
|
3. Debug Meta
|
||
|
4. Toggle Beta Features
|
||
|
|
||
|
![Screenshot 2023-05-23 at 8 35 14 PM](https://github.com/nocodb/nocodb/assets/86527202/fe2765fa-5796-4d26-8c12-e71b8226872e)
|
||
|
|
||
2 years ago
|
|