From 922919e29a362a0c3ddd2006d90a0a5160e0d456 Mon Sep 17 00:00:00 2001 From: Wing-Kam Wong Date: Tue, 25 Jan 2022 19:22:52 +0800 Subject: [PATCH] docs: refer to english version Signed-off-by: Wing-Kam Wong --- README.md | 52 +--------------------------------------------------- 1 file changed, 1 insertion(+), 51 deletions(-) diff --git a/README.md b/README.md index a711a6d903..0ffc9555d3 100644 --- a/README.md +++ b/README.md @@ -233,57 +233,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 -``` - -## Running Backend locally - -```shell -cd nocodb/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://github.com/nocodb/nocodb/tree/master#development-setup) # Contributing