diff --git a/doc/dev_guide/setup_run.md b/doc/dev_guide/setup_run.md index 538f35fc..8d1f6d6a 100644 --- a/doc/dev_guide/setup_run.md +++ b/doc/dev_guide/setup_run.md @@ -1,10 +1,19 @@ # 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. +**Step 1 -** Fork the project. -#### 4. Setup melos +**Step 2 -** Create a clone of the forked project on your computer to run it locally. + +**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= . +``` + +**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. + +**Step 5 -** Setup melos As API Dash is a monorepo with multi-package architecture we use [melos](https://pub.dev/packages/melos). @@ -24,13 +33,13 @@ Get all dependencies of packages melos pub-get ``` -Get all dependencies of app +**Step 6 -** Get all dependencies of the app ``` flutter pub get ``` -Run the project by executing the following command: +**Step 7 -** Run the project by executing the below command ``` flutter run