Browse Source

docs : development setup page

pull/2553/head
Naveen MR 2 years ago
parent
commit
6f983d1fa7
  1. 48
      packages/noco-docs/content/en/engineering/development-setup.md
  2. 10
      packages/noco-docs/content/en/engineering/timely-build.md

48
packages/noco-docs/content/en/engineering/development-setup.md

@ -6,20 +6,34 @@ category: "Engineering"
menuTitle: "Development setup" menuTitle: "Development setup"
--- ---
We use ``Lerna`` to manage multi-packages. We have the following [packages](https://github.com/nocodb/nocodb/tree/master/packages). ### Clone the repo
```
- ``packages/nc-cli`` : A CLI to create NocoDB app. git clone https://github.com/nocodb/nocodb
cd nocodb/packages
- ``packages/nocodb-sdk``: API client sdk of nocodb. ```
- ``packages/nc-gui``: NocoDB Frontend. ### Build SDK
```
- ``packages/nc-lib-gui``: The build version of ``nc-gui`` which will be used in ``packages/nocodb``. # build nocodb-sdk
cd nocodb-sdk
- ``packages/nc-plugin``: Plugin template. npm install
npm run build
- ``packages/noco-blog``: NocoDB Blog which will be auto-released to [nocodb/noco-blog](https://github.com/nocodb/noco-blog). ```
- ``packages/noco-docs``: NocoDB Documentation which will be auto-released to [nocodb/noco-docs](https://github.com/nocodb/noco-docs). ### Build Backend
```
- ``packages/nocodb``: NocoDB Backend, hosted in [NPM](https://www.npmjs.com/package/nocodb). # build backend - runs on port 8080
cd ../nocodb
npm install
npm run watch:run
```
### Build Frontend
```
# build frontend - runs on port 3000
cd ../nc-gui
npm install
npm run dev
```
Any changes made to frontend and backend will be automatically reflected in the browser.

10
packages/noco-docs/content/en/engineering/timely-build.md

@ -1,19 +1,19 @@
--- ---
title: "Daily builds explained" title: "Build on pull requests"
description: "Daily builds explained" description: "Build on pull requests"
position: 3250 position: 3250
category: "Engineering" category: "Engineering"
menuTitle: "Daily builds explained" menuTitle: "Build on pull requests"
--- ---
NocoDB provides timely build versions on Docker and Executables by compiling our source code and packaging as a deliverable so that it can NocoDB creates docker and binaries for each PR.
This is to
- reduce pull request cycle time - reduce pull request cycle time
- allow issue reporters / reviewers to verify the fix without setting up their local machines - allow issue reporters / reviewers to verify the fix without setting up their local machines
## Docker ## Docker
When a non-draft Pull Request is created, reopened or synchronized, a timely build for Docker would be triggered for the changes only included in the following paths. When a non-draft Pull Request is created, reopened or synchronized, a timely build for Docker would be triggered for the changes only included in the following paths.
- `packages/nocodb-sdk/**` - `packages/nocodb-sdk/**`

Loading…
Cancel
Save