From 8cea1210e4a7ccf78e8ff17cb2dd13e1388183d3 Mon Sep 17 00:00:00 2001 From: Confidence Okoghenun Date: Fri, 11 Jun 2021 09:55:46 +0100 Subject: [PATCH] Updates mkcert installation steps in docs (#4637) --- app/client/README.md | 2 +- contributions/ClientSetup.md | 12 ++++++++++++ 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/app/client/README.md b/app/client/README.md index 2a275ea504..4a5ba02f8e 100755 --- a/app/client/README.md +++ b/app/client/README.md @@ -6,4 +6,4 @@ This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). -For details on setting up your development machine, please refer to the [Setup Guide](https://github.com/appsmithorg/appsmith/blob/release/contributions/ClientSetup.md) +For details on setting up your development machine, please refer to the [Setup Guide](../../contributions/ClientSetup.md) diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index cfcefa1104..5eb3fb1a3d 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -8,6 +8,18 @@ On your development machine, please ensure that: 1. You have `docker` installed in your system. If not, please visit: [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/) 1. You have `mkcert` installed. Please visit: [https://github.com/FiloSottile/mkcert#installation](https://github.com/FiloSottile/mkcert#installation) for details. For `mkcert` to work with Firefox you may require the `nss` utility to be installed. Details are in the link above. + + Note: + - On Linux you can easily install `mkcert` using the following command + ``` + curl -s https://api.github.com/repos/FiloSottile/mkcert/releases/latest \ + | grep "browser_download_url.*linux-amd64" \ + | cut -d : -f 2,3 | tr -d \" \ + | wget -i - -O mkcert + chmod +x mkcert + sudo mv mkcert /usr/local/bin + ``` + 1. You have `envsubst` installed. use `brew install gettext` on MacOS. Linux machines usually have this installed. 1. You have cloned the repo in your local machine. 1. You have yarn installed as a global npm package i.e. `npm install -g yarn`