mirror of https://github.com/nocodb/nocodb
Wing-Kam Wong
3 years ago
3 changed files with 25 additions and 10 deletions
@ -1,11 +1,5 @@
|
||||
# `xc-tool-web` |
||||
# nc-lib-gui |
||||
|
||||
> TODO: description |
||||
This package is the build version of ``nc-gui`` which will be used in ``packages/nocodb``. The built files should be located in ``packages/nc-lib-gui/lib/dist/``. |
||||
|
||||
## Usage |
||||
|
||||
``` |
||||
const xcToolWeb = require('xc-tool-web'); |
||||
|
||||
// TODO: DEMONSTRATE API |
||||
``` |
||||
To build the frontend and copy the built files to dist directory, run ``npm run build:copy`` under ``packages/nc-gui/``. |
@ -0,0 +1,21 @@
|
||||
# nocodb |
||||
|
||||
## Running locally |
||||
|
||||
Even though this package is a backend project, you can still visit the dashboard as it includes ``nc-lib-gui``. |
||||
|
||||
``` |
||||
npm install |
||||
npm run watch:run |
||||
# open localhost:8080/dashboard in browser |
||||
``` |
||||
|
||||
As ``nc-lib-gui`` is hosted in npm registry, for local development, you should run ``nc-gui`` separately. |
||||
|
||||
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/``. |
Loading…
Reference in new issue