diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index 5f152c6685..91719f74d2 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -52,6 +52,12 @@ cd app/client Your client is pointing to the cloud staging server https://release-api.appsmith.com +#### If yarn start throws mismatch node version error +This error occurs because the node version is not compatible with the app environment. In this case Node version manager can be used which allows multiple +node versions to be used in different projects. Check below for installation and usage details: +1. Install a node version manager. For eg: check [nvm](https://github.com/nvm-sh/nvm) or [fnm](https://github.com/Schniz/fnm). +2. In the root of the project, run `nvm use 10.16.3` or `fnm use 10.16.3`. + #### If you would like to hit a different Appsmith server: - Change the API endpoint in the Nginx configuration files (`app/client/docker/templates/nginx-linux.conf.template` or `app/client/docker/templates/nginx-mac.conf.template`). - Run `start-https.sh` script again. @@ -67,4 +73,4 @@ REACT_APP_ENVIRONMENT=DEVELOPMENT HOST=dev.appsmith.com craco start 2. `proxy_pass` value must be changed from `http://host.docker.internal:3000` to `http://localhost:3000` 3. Generate the certificates manually via `mkcert`. Check the command in `start-https-server.sh` file. 4. Change the value of the certificate location for keys `ssl_certificate` & `ssl_certificate_key` to the place where these certificates were generated. -5. If you ran `./start-https`, but containers failed to start (you have to check with `docker ps` since it fails silently). Some Linux distros (`Ubuntu` for example) have installed and running `apache2` webserver on port `80`. This can result in `Address already in use` error (you can check with `docker logs wildcard-nginx`). Simple solution for this is simply turning it off temporarily with `sudo systemctl stop apache2`. After that just run `./start-https` again. \ No newline at end of file +5. If you ran `./start-https`, but containers failed to start (you have to check with `docker ps` since it fails silently). Some Linux distros (`Ubuntu` for example) have installed and running `apache2` webserver on port `80`. This can result in `Address already in use` error (you can check with `docker logs wildcard-nginx`). Simple solution for this is simply turning it off temporarily with `sudo systemctl stop apache2`. After that just run `./start-https` again.