diff --git a/packages/noco-docs/content/en/setup-and-usages/installation.md b/packages/noco-docs/content/en/setup-and-usages/installation.md index 48e68b6991..8f34e04396 100644 --- a/packages/noco-docs/content/en/setup-and-usages/installation.md +++ b/packages/noco-docs/content/en/setup-and-usages/installation.md @@ -19,7 +19,9 @@ Simple installation - takes about three minutes! - An example database schema can be found here. ## Quick try -### 1-Click Deploy + +### 1-Click Deploy to Heroku + -### Node app or docker +### Node app / Docker @@ -60,17 +62,49 @@ Simple installation - takes about three minutes! - -

-# Production Setup +## Local Setup + +If you want to modify the source code, there are two scenarios. You can either + +- change backend only or +- change both frontend and backend separately + +Even though the package ``nocodb/packages/nocodb`` is a backend project, you can still visit the dashboard as it includes ``nc-lib-gui``. + +```bash +cd packages/nocodb +npm install +npm run watch:run +# open localhost:8080/dashboard in browser +``` + +As ``nc-lib-gui`` is hosted in npm registry, for local development on frontend part, you should run ``nc-gui`` separately. + +```bash +cd packages/nc-gui +npm install +npm run dev +# open localhost:3000/dashboard in browser +``` + +If you wish to combine the frontend and backend together in your local devlopment environment, you may use ``packages/nc-lib-gui`` as a local depenedency by updating the ``packages/nocodb/package.json`` to + +```json +"nc-lib-gui": "file:../nc-lib-gui" +``` + +In this case, whenever there is any changes made in frontend, you need to run ``npm run build:copy`` under ``packages/nc-gui/``. + +## Production Setup + NocoDB requires a database to store metadata of spreadsheets views and external databases. And connection params for this database can be specified in `NC_DB` environment variable. -## Docker +### Docker @@ -107,7 +141,7 @@ And connection params for this database can be specified in `NC_DB` environment -## Docker Compose +### Docker Compose