docs : development setup page

3 years ago · 426a95de8c
17 changed files with 67 additions and 16923 deletions
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@ -35,7 +35,7 @@ Thanks for spending your time to contribute! The following is a set of guideline

 ## Development Setup

-Please refer to [Development Setup](https://github.com/nocodb/nocodb#development-setup).
+Please refer to [Development Setup](https://docs.nocodb.com/engineering/development-setup).

 ### Committing Changes

--- a/README.md
+++ b/README.md
@ -316,65 +316,7 @@ Please refer to [Environment variables](https://docs.nocodb.com/getting-started/

 # Development Setup 

-## Cloning the Project
-
-```shell
-git clone https://github.com/nocodb/nocodb
-cd nocodb
-```
-
-## Build SDK
-
-```shell
-cd packages/nocodb-sdk
-npm install
-npm run build
-```
-
-## Running Backend locally
-
-```shell
-cd packages/nocodb
-npm install
-npm run watch:run
-# open localhost:8080/dashboard in browser
-```
-
-## Running Frontend locally 
-
-```shell
-cd packages/nc-gui
-npm install
-npm run dev
-# open localhost:3000/dashboard in browser
-```
-
-Changes made to code automatically restart.
-
-> nocodb/packages/nocodb includes nc-lib-gui which is the built version of nc-gui hosted in npm registry. You can visit localhost:8000/dashboard in browser after starting the backend locally if you just want to modify the backend only.
-
-## Running Cypress tests locally
-
-```shell
-# install dependencies(cypress)
-npm install
-
-# run mysql database with required database using docker compose
-docker-compose -f ./scripts/docker-compose-cypress.yml up
-
-# Run backend api using following command
-npm run start:api
-
-# Run frontend web UI using following command
-npm run start:web
-
-# wait until both 3000 and 8080 ports are available
-# and run cypress test using following command
-npm run cypress:run
-
-# or run following command to run it with GUI
-npm run cypress:open
-```
+Please refer to [Development Setup](https://docs.nocodb.com/engineering/development-setup)

 # Contributing

--- a/packages/noco-docs/content/en/engineering/architecture.md
+++ b/packages/noco-docs/content/en/engineering/architecture.md
@ -1,9 +1,9 @@
 ---
-title: "NocoDB Architecture"
-description: "NocoDB Architecture Overview"
-position: 4000
+title: "NocoDB architecture"
+description: "Simple overview of NocoDB architecture"
+position: 3000
 category: "Engineering"
-menuTitle: "NocoDB Architecture"
+menuTitle: "NocoDB architecture"
 ---

 By default, if `NC_DB` is not specified, then SQLite will be used to store your meta data. We suggest users to separate the meta data and user data in different databases.
--- a/packages/noco-docs/content/en/engineering/development-setup.md
+++ b/packages/noco-docs/content/en/engineering/development-setup.md
@ -0,0 +1,25 @@
+---
+title: "Development setup"
+description: "How to setup your development environment"
+position: 3200
+category: "Engineering"
+menuTitle: "Development setup"
+---
+
+We use ``Lerna`` to manage multi-packages. We have the following [packages](https://github.com/nocodb/nocodb/tree/master/packages).
+
+- ``packages/nc-cli`` : A CLI to create NocoDB app.
+
+- ``packages/nocodb-sdk``: API client sdk of nocodb.
+
+- ``packages/nc-gui``: NocoDB Frontend.
+
+- ``packages/nc-lib-gui``: The build version of ``nc-gui`` which will be used in ``packages/nocodb``.
+
+- ``packages/nc-plugin``: Plugin template.
+
+- ``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).
+
+- ``packages/nocodb``: NocoDB Backend, hosted in [NPM](https://www.npmjs.com/package/nocodb).
--- a/packages/noco-docs/content/en/engineering/repository-structure.md
+++ b/packages/noco-docs/content/en/engineering/repository-structure.md
@ -1,9 +1,9 @@
 ---
-title: "Repository Structure"
-description: "NocoDB Repository Structure Overview"
-position: 3000
+title: "Repository structure"
+description: "Repository structure"
+position: 3100
 category: "Engineering"
-menuTitle: "Repository Structure"
+menuTitle: "Repository structure"
 ---

 We use ``Lerna`` to manage multi-packages. We have the following [packages](https://github.com/nocodb/nocodb/tree/master/packages).
@ -16,16 +16,10 @@ We use ``Lerna`` to manage multi-packages. We have the following [packages](http

 - ``packages/nc-lib-gui``: The build version of ``nc-gui`` which will be used in ``packages/nocodb``.

- ``packages/nc-migrator-archived``: SQL based schema migrations or evolutions.
-
 - ``packages/nc-plugin``: Plugin template.

 - ``packages/noco-blog``: NocoDB Blog which will be auto-released to [nocodb/noco-blog](https://github.com/nocodb/noco-blog).

- ``packages/noco-book``: NocoDB Handbook which will be auto-released to [nocodb/noco-book](https://github.com/nocodb/noco-book).
-
 - ``packages/noco-docs``: NocoDB Documentation which will be auto-released to [nocodb/noco-docs](https://github.com/nocodb/noco-docs).

- ``packages/noco-docs-prev``: NocoDB Documentation for previous versions which will be auto-released to [nocodb/noco-docs-prev](https://github.com/nocodb/noco-docs-prev) and will be completely removed on 30 Jun 2022.
-
 - ``packages/nocodb``: NocoDB Backend, hosted in [NPM](https://www.npmjs.com/package/nocodb).
--- a/packages/noco-docs/content/en/engineering/timely-build.md
+++ b/packages/noco-docs/content/en/engineering/timely-build.md
@ -1,9 +1,9 @@
 ---
-title: "Timely Build"
-description: "NocoDB provides Timely Build for Docker and Binary Executables"
-position: 5000
+title: "Daily builds explained"
+description: "Daily builds explained"
+position: 3250
 category: "Engineering"
-menuTitle: "Timely Build"
+menuTitle: "Daily builds explained"
 ---

 NocoDB provides timely build versions on Docker and Executables by compiling our source code and packaging as a deliverable so that it can
--- a/packages/noco-docs/content/en/engineering/translation.md
+++ b/packages/noco-docs/content/en/engineering/translation.md
@ -1,9 +1,9 @@
 ---
-title: "i18n"
-description: "How to contribute to NocoDB's i18n translation?"
-position: 2000
+title: "i18n translation"
+description: "Contribute to NocoDB's i18n translation"
+position: 3400
 category: "Engineering"
-menuTitle: "i18n"
+menuTitle: "i18n translation"
 ---

 NocoDB supports many foreign languages & we welcome community contributions via an easy to use [google-spreadsheet](https://docs.google.com/spreadsheets/d/1kGp92yLwhs1l7lwwgeor3oN1dFl7JZWuQOa4WSeZ0TE/edit#gid=2076107172).
--- a/packages/noco-docs/content/en/getting-started/installation.md
+++ b/packages/noco-docs/content/en/getting-started/installation.md
@ -367,7 +367,7 @@ aws ecs create-service \
 </alert>

 ## Development Setup
-Please refer to [Development Setup](https://github.com/nocodb/nocodb#development-setup).
+Please refer to [Development Setup](https://docs.nocodb.com/engineering/development-setup).

 ## Sample Demos

--- a/packages/noco-docs/content/en/index.md
+++ b/packages/noco-docs/content/en/index.md
@ -82,7 +82,7 @@ Thanks for spending your time to contribute! The following is a set of guideline

 ## Development Setup

-Please refer to [Development Setup](https://github.com/nocodb/nocodb#development-setup).
+Please refer to [Development Setup](https://docs.nocodb.com/engineering/development-setup).

 ### Committing Changes

--- a/packages/noco-docs/package-lock.json
+++ b/packages/noco-docs/package-lock.json
--- a/scripts/markdown/readme/languages/dutch.md
+++ b/scripts/markdown/readme/languages/dutch.md
@ -198,7 +198,7 @@ Please refer to [Environment variables](https://docs.nocodb.com/getting-started/

 # Development setup

-Please refer to [Development Setup](https://github.com/nocodb/nocodb/tree/master#development-setup)
+Please refer to [Development Setup](https://docs.nocodb.com/engineering/development-setup)

 # Contributing

--- a/scripts/markdown/readme/languages/french.md
+++ b/scripts/markdown/readme/languages/french.md
@ -198,7 +198,7 @@ Please refer to [Environment variables](https://docs.nocodb.com/getting-started/

 # Paramétrage du développement

-Please refer to [Development Setup](https://github.com/nocodb/nocodb/tree/master#development-setup)
+Please refer to [Development Setup](https://docs.nocodb.com/engineering/development-setup)

 # Contribuant

--- a/scripts/markdown/readme/languages/indonesian.md
+++ b/scripts/markdown/readme/languages/indonesian.md
@ -199,7 +199,7 @@ Please refer to [Environment variables](https://docs.nocodb.com/getting-started/

 # Pengaturan Pengembangan

-Please refer to [Development Setup](https://github.com/nocodb/nocodb/tree/master#development-setup)
+Please refer to [Development Setup](https://docs.nocodb.com/engineering/development-setup)

 # Berkontribusi

--- a/scripts/markdown/readme/languages/italian.md
+++ b/scripts/markdown/readme/languages/italian.md
@ -202,7 +202,7 @@ Please refer to [Environment variables](https://docs.nocodb.com/getting-started/

 # Setup di sviluppo

-Please refer to [Development Setup](https://github.com/nocodb/nocodb/tree/master#development-setup)
+Please refer to [Development Setup](https://docs.nocodb.com/engineering/development-setup)

 # Contributi

--- a/scripts/markdown/readme/languages/japanese.md
+++ b/scripts/markdown/readme/languages/japanese.md
@ -201,7 +201,7 @@ Please refer to [Environment variables](https://docs.nocodb.com/getting-started/

 # Development setup

-Please refer to [Development Setup](https://github.com/nocodb/nocodb/tree/master#development-setup)
+Please refer to [Development Setup](https://docs.nocodb.com/engineering/development-setup)

 # Contributing

--- a/scripts/markdown/readme/languages/korean.md
+++ b/scripts/markdown/readme/languages/korean.md
@ -202,7 +202,7 @@ Please refer to [Environment variables](https://docs.nocodb.com/getting-started/

 # 개발 환경에 설치하기

-Please refer to [Development Setup](https://github.com/nocodb/nocodb/tree/master#development-setup)
+Please refer to [Development Setup](https://docs.nocodb.com/engineering/development-setup)

 # 기여하기

--- a/scripts/markdown/readme/languages/portuguese.md
+++ b/scripts/markdown/readme/languages/portuguese.md
@ -200,7 +200,7 @@ Please refer to [Environment variables](https://docs.nocodb.com/getting-started/

 # Development setup

-Please refer to [Development Setup](https://github.com/nocodb/nocodb/tree/master#development-setup)
+Please refer to [Development Setup](https://docs.nocodb.com/engineering/development-setup)

 # Contributing