From c7149f859ee2f24110f3862ee57cf6c4e2d7c53a Mon Sep 17 00:00:00 2001 From: Mukul Gehlot <imukulgehlot@gmail.com> Date: Sat, 9 Nov 2024 02:53:25 +0530 Subject: [PATCH 1/5] docs: Add platform setup instructions for macOS, Windows, and Linux MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit docs: Add platform setup instructions for macOS, Windows, and Linux - Updated step 3 in setup_run.md to include platform-specific instructions for enabling Windows, macOS, or Linux based on the user’s desktop environment. - Added `flutter create --platforms=<platform>` command example for clarity. - Added a reference to `platform_specific_instructions.md` to guide users on configuring platform-specific requirements after setup. This update clarifies setup steps and reduces confusion for new contributors by centralizing necessary setup instructions in one place. --- doc/dev_guide/setup_run.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/doc/dev_guide/setup_run.md b/doc/dev_guide/setup_run.md index 538f35fc..bdbc42d4 100644 --- a/doc/dev_guide/setup_run.md +++ b/doc/dev_guide/setup_run.md @@ -1,10 +1,16 @@ # How to run API Dash locally? -1. Fork the project. -2. Create a clone of the forked project on your computer to run it locally. -3. Based on your desktop environment, enable Windows, macOS or Linux for the project. Select the same target device. +#### 1. Fork the project. +#### 2. Create a clone of the forked project on your computer to run it locally. +#### 3. Based on your desktop environment, enable Windows, macOS, or Linux for the project. Select the same target device. + Choose any of the following platforms: `windows`, `macos`, or `linux`. -#### 4. Setup melos + ```bash + flutter create --platforms=<platform> . + ``` +#### 4. Check [platform_specific_instructions.md](https://github.com/imukulgehlot/apidash/blob/setup-run-platform-guide/doc/dev_guide/platform_specific_instructions.md) to add required platform specific configurations. + +#### 5. Setup melos As API Dash is a monorepo with multi-package architecture we use [melos](https://pub.dev/packages/melos). From 0535911ae79b3457c45769ccce662ab750e31f25 Mon Sep 17 00:00:00 2001 From: Ashita Prasad <ashitaprasad92@gmail.com> Date: Sat, 9 Nov 2024 05:31:03 +0530 Subject: [PATCH 2/5] Update setup_run.md --- doc/dev_guide/setup_run.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/dev_guide/setup_run.md b/doc/dev_guide/setup_run.md index bdbc42d4..1c4c937b 100644 --- a/doc/dev_guide/setup_run.md +++ b/doc/dev_guide/setup_run.md @@ -30,13 +30,13 @@ Get all dependencies of packages melos pub-get ``` -Get all dependencies of app +#### 6. Get all dependencies of the app ``` flutter pub get ``` -Run the project by executing the following command: +#### 7. Run the project by executing the below command ``` flutter run From d970221abed5542bd0552bbb9e826ff1a4107ae1 Mon Sep 17 00:00:00 2001 From: Ashita Prasad <ashitaprasad92@gmail.com> Date: Sat, 9 Nov 2024 05:32:05 +0530 Subject: [PATCH 3/5] Update setup_run.md --- doc/dev_guide/setup_run.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/doc/dev_guide/setup_run.md b/doc/dev_guide/setup_run.md index 1c4c937b..c24880cc 100644 --- a/doc/dev_guide/setup_run.md +++ b/doc/dev_guide/setup_run.md @@ -1,13 +1,16 @@ # How to run API Dash locally? #### 1. Fork the project. -#### 2. Create a clone of the forked project on your computer to run it locally. -#### 3. Based on your desktop environment, enable Windows, macOS, or Linux for the project. Select the same target device. - Choose any of the following platforms: `windows`, `macos`, or `linux`. - ```bash - flutter create --platforms=<platform> . - ``` +#### 2. Create a clone of the forked project on your computer to run it locally. + +#### 3. Based on your desktop environment, enable Windows, macOS, or Linux for the project. Select the same target device. +Choose any of the following platforms: `windows`, `macos`, or `linux`. + +```bash +flutter create --platforms=<platform> . +``` + #### 4. Check [platform_specific_instructions.md](https://github.com/imukulgehlot/apidash/blob/setup-run-platform-guide/doc/dev_guide/platform_specific_instructions.md) to add required platform specific configurations. #### 5. Setup melos From 2c708d969d3e05aebe94f9521d34b0076acd6244 Mon Sep 17 00:00:00 2001 From: Ashita Prasad <ashitaprasad92@gmail.com> Date: Sat, 9 Nov 2024 05:32:51 +0530 Subject: [PATCH 4/5] Update setup_run.md --- doc/dev_guide/setup_run.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/dev_guide/setup_run.md b/doc/dev_guide/setup_run.md index c24880cc..d5970829 100644 --- a/doc/dev_guide/setup_run.md +++ b/doc/dev_guide/setup_run.md @@ -5,7 +5,7 @@ #### 2. Create a clone of the forked project on your computer to run it locally. #### 3. Based on your desktop environment, enable Windows, macOS, or Linux for the project. Select the same target device. -Choose any of the following platforms: `windows`, `macos`, or `linux`. +Choose any of the following platforms: `windows`, `macos`, `linux`, `android` or `ios`. ```bash flutter create --platforms=<platform> . From 3acb581b40e0c4c41e04716610549c27ec30b4d5 Mon Sep 17 00:00:00 2001 From: Ashita Prasad <ashitaprasad92@gmail.com> Date: Sat, 9 Nov 2024 05:36:23 +0530 Subject: [PATCH 5/5] Update setup_run.md --- doc/dev_guide/setup_run.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/dev_guide/setup_run.md b/doc/dev_guide/setup_run.md index d5970829..8d1f6d6a 100644 --- a/doc/dev_guide/setup_run.md +++ b/doc/dev_guide/setup_run.md @@ -1,19 +1,19 @@ # How to run API Dash locally? -#### 1. Fork the project. +**Step 1 -** Fork the project. -#### 2. Create a clone of the forked project on your computer to run it locally. +**Step 2 -** Create a clone of the forked project on your computer to run it locally. -#### 3. Based on your desktop environment, enable Windows, macOS, or Linux for the project. Select the same target device. +**Step 3 -** Based on your desktop environment, enable Windows, macOS, or Linux for the project. Select the same target device. Choose any of the following platforms: `windows`, `macos`, `linux`, `android` or `ios`. ```bash flutter create --platforms=<platform> . ``` -#### 4. Check [platform_specific_instructions.md](https://github.com/imukulgehlot/apidash/blob/setup-run-platform-guide/doc/dev_guide/platform_specific_instructions.md) to add required platform specific configurations. +**Step 4 -** Check [Platform Specific Instructions](https://github.com/imukulgehlot/apidash/blob/setup-run-platform-guide/doc/dev_guide/platform_specific_instructions.md) to add required platform specific configurations. -#### 5. Setup melos +**Step 5 -** Setup melos As API Dash is a monorepo with multi-package architecture we use [melos](https://pub.dev/packages/melos). @@ -33,13 +33,13 @@ Get all dependencies of packages melos pub-get ``` -#### 6. Get all dependencies of the app +**Step 6 -** Get all dependencies of the app ``` flutter pub get ``` -#### 7. Run the project by executing the below command +**Step 7 -** Run the project by executing the below command ``` flutter run