flutter/apidash
1
0
Fork 0
mirror of https://github.com/foss42/apidash.git synced 2025-06-22 15:29:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #495 from imukulgehlot/setup-run-platform-guide

Browse Source 
Add platform setup instructions for macOS, Windows, and Linux
This commit is contained in:
Ashita Prasad
2024-11-09 05:37:08 +05:30
committed by GitHub
parent b6cdf60365 3acb581b40
commit aae076e02c
1 changed files with 15 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/dev_guide/setup_run.md
View File

@ -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=<platform> .
```
**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