From a247231fa511980e7eff780c7b8bfa5ce4abee71 Mon Sep 17 00:00:00 2001 From: saurabh Date: Tue, 28 Feb 2023 10:30:47 +0530 Subject: [PATCH 1/2] docs: add steps for project development setup --- CONTRIBUTING.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 512e71552..827dedc8c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,19 @@ If you are worried about or don’t know where to start, check out the next sect ## Development -Once you've created a project and installed dependencies with `npm install`, create a `.env` file using `.env.example` as a template. +### 1. Clone the repository with git +```bash +git clone https://github.com/appwrite/console.git appwrite-console +``` + +### 2. Install dependencies with npm +```bash +npm install +``` + +### 3. Setup environment variables + +add .env file using .env.example file as a template in project root directory Finally, start a development server: From b7cab43020a383997d0746ad2c50e1c09b31d865 Mon Sep 17 00:00:00 2001 From: Saurabh <57309205+saurabhmehta1601@users.noreply.github.com> Date: Tue, 28 Feb 2023 21:44:17 +0530 Subject: [PATCH 2/2] Update CONTRIBUTING.md Co-authored-by: Vincent (Wen Yu) Ge --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 827dedc8c..de572975b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,7 +45,7 @@ npm install ### 3. Setup environment variables -add .env file using .env.example file as a template in project root directory +Add a `.env` file by copying the `.env.example` file as a template in the project's root directory. Finally, start a development server: