diff --git a/packages/noco-docs/content/en/developer-resources/api-tokens.md b/packages/noco-docs/content/en/developer-resources/api-tokens.md index 4ef224b5fc..8ca09c5770 100644 --- a/packages/noco-docs/content/en/developer-resources/api-tokens.md +++ b/packages/noco-docs/content/en/developer-resources/api-tokens.md @@ -10,15 +10,16 @@ menuTitle: 'API Tokens' ## API Tokens NocoDB allows creating API tokens which allow it to be integrated seamlessly with 3rd party apps. -### Creating API tokens +### Which HTTP Header to use ? +- ```xc-token``` header should be set when invoking the NocoDB APIs with the token. -![1](https://user-images.githubusercontent.com/5435402/133734223-49bb1567-6cd2-43e5-bdda-aaccda741070.png) -![2](https://user-images.githubusercontent.com/5435402/133734234-5ca542b1-5843-46f7-b97b-9e686c6bf7ac.png) -![3](https://user-images.githubusercontent.com/5435402/133734238-33d5bdd0-5c97-4dbe-8e49-744193c3ac20.png) -![4](https://user-images.githubusercontent.com/5435402/133734239-7b530235-3352-497b-b23c-3a701290a569.png) -![5](https://user-images.githubusercontent.com/5435402/133734241-0f25bbd0-ab92-430a-9987-cc745d5b1b47.png) -![6](https://user-images.githubusercontent.com/5435402/133734243-6dc8527e-573d-45e2-8cd8-13a8beea0dfa.png) +### How to create a token ? + +- ![1](https://user-images.githubusercontent.com/5435402/133734223-49bb1567-6cd2-43e5-bdda-aaccda741070.png) +- ![2](https://user-images.githubusercontent.com/5435402/133734234-5ca542b1-5843-46f7-b97b-9e686c6bf7ac.png) +- ![3](https://user-images.githubusercontent.com/5435402/133734238-33d5bdd0-5c97-4dbe-8e49-744193c3ac20.png) +- ![4](https://user-images.githubusercontent.com/5435402/133734239-7b530235-3352-497b-b23c-3a701290a569.png) +- ![5](https://user-images.githubusercontent.com/5435402/133734241-0f25bbd0-ab92-430a-9987-cc745d5b1b47.png) +- ![6](https://user-images.githubusercontent.com/5435402/133734243-6dc8527e-573d-45e2-8cd8-13a8beea0dfa.png) -### Using API Tokens -Invoke NocoDB APIs with ```xc-token``` header diff --git a/packages/noco-docs/content/en/getting-started/installation.md b/packages/noco-docs/content/en/getting-started/installation.md index e941d4bdca..6ca476c31b 100644 --- a/packages/noco-docs/content/en/getting-started/installation.md +++ b/packages/noco-docs/content/en/getting-started/installation.md @@ -66,32 +66,6 @@ Simple installation - takes about three minutes! > To persist data in docker you can mount volume at `/usr/app/data/` since 0.10.6. In older version mount at `/usr/src/app`. -## Development Setup - -If you want to modify the source code, - -- Start the backend locally - -```bash -cd packages/nocodb -npm install -npm run watch:run -``` - -- Start the frontend locally - -```bash -cd packages/nc-gui -npm install -npm run dev -``` - -- Open ``localhost:3000/dashboard`` in browser - - - 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. - ## Production Setup @@ -301,6 +275,32 @@ aws ecs create-service \ If your service fails to start, you may check the logs in ECS console or in Cloudwatch. Generally it fails due to the connection between ECS container and NC_DB. Make sure the security groups have the correct inbound and outbound rules. +## Development Setup + +If you want to modify the source code, + +- Start the backend locally + +```bash +cd packages/nocodb +npm install +npm run watch:run +``` + +- Start the frontend locally + +```bash +cd packages/nc-gui +npm install +npm run dev +``` + +- Open ``localhost:3000/dashboard`` in browser + + + 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. + ## Sample Demos