mirror of
https://github.com/foss42/apidash.git
synced 2025-12-02 10:49:49 +08:00
162 lines
5.9 KiB
Markdown
162 lines
5.9 KiB
Markdown
# Installation Instructions
|
||
|
||
|
||
## Windows
|
||
|
||
- Download the latest Windows Installer (64 bit) from [here](https://github.com/foss42/apidash/releases/latest)
|
||
- To install it, simply double click on the installer.
|
||
- If prompted by Windows that **Windows prevented an unrecognized app from running**, click on **Run anyway**.
|
||
- Now, follow the step by step installation wizard.
|
||
|
||
Detailed, step by step instructions are provided below:
|
||
|
||
### Step 1: Download the Installer
|
||
1. Visit the [latest release page](https://github.com/foss42/apidash/releases/latest) on GitHub.
|
||
2. Download the **Windows Installer (64-bit)** file.
|
||
|
||
### Step 2: Install the Application
|
||
1. Locate the downloaded installer file (usually found in your `Downloads` folder).
|
||
2. Double-click on the installer to begin the installation process.
|
||
|
||
### Step 3: Handle Windows Security Warnings
|
||
- **Unrecognized App Warning**:
|
||
If you see a message saying:
|
||
> *Windows protected your PC*
|
||
This occurs because the app is from an unrecognized publisher.
|
||
- Click on **More info**.
|
||
- Then, click on **Run anyway** to proceed.
|
||
|
||
### Step 4: Follow the Installation Wizard
|
||
1. Follow the step-by-step instructions provided in the installation wizard.
|
||
2. Customize the installation location if required, or proceed with the default options.
|
||
3. Click **Install** to complete the process.
|
||
|
||
### Step 5: Launch the Application
|
||
Once the installation is complete, you can:
|
||
- Launch the application directly from the final screen of the installer.
|
||
- Or, open it later from the Start Menu or Desktop shortcut.
|
||
|
||
## MacOS
|
||
|
||
Download the latest MacOS Installer (Universal - Intel and Apple Silicon) from [here](https://github.com/foss42/apidash/releases/latest)
|
||
|
||
**As this app is distributed outside the App Store you have to follow the following instructions to setup and run it only for the first time.**
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
In case, you see a different dialog other than the one shown below, check out [this section](#open-via-settings)
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
This process has to be followed only once and from the next time you can directly launch the API Dash App from the Launchpad.
|
||
|
||
### Open via Settings
|
||
|
||
In macOS, if you do not get an option to open immediately, follow the following steps to install API Dash:
|
||
|
||
|
||
|
||
Go to Settings > Privacy and Security
|
||
|
||
|
||
|
||
|
||
|
||
Now drag to the `Applications` folder
|
||
|
||
|
||
|
||
##
|
||
|
||
You can refer to the video given below which shows the steps to install and run API Dash on macOS.
|
||
|
||
https://user-images.githubusercontent.com/1382619/227956871-87376f18-d80f-4a53-9456-cb724f8149c7.mp4
|
||
|
||
## Linux
|
||
|
||
### Debian-based Linux Distributions (Debian, Ubuntu, Linux Mint, etc.)
|
||
|
||
Download the `.deb` file from the [latest release](https://github.com/foss42/apidash/releases/latest) corresponding to you CPU architecture (x64/amd64 or arm64).
|
||
|
||
`cd` to the Downloads folder and execute the following command to install API Dash.
|
||
|
||
```
|
||
sudo apt install ./apidash-<fullname>.deb
|
||
```
|
||
|
||
or
|
||
|
||
```
|
||
sudo dpkg -i apidash-<fullname>.deb
|
||
```
|
||
|
||
Launch API Dash via `apidash` command or by clicking on the API Dash app icon.
|
||
|
||
### Red Hat-based Linux Distributions (Fedora, Rocky, AlmaLinux, CentOS, RHEL, etc.)
|
||
|
||
Download the `.rpm` file from the [latest release](https://github.com/foss42/apidash/releases/latest) corresponding to you CPU architecture (x86_64 or aarch64/arm64).
|
||
|
||
`cd` to the Downloads folder and execute the following command to install API Dash.
|
||
|
||
```
|
||
sudo dnf localinstall ./apidash-<fullname>.rpm
|
||
```
|
||
|
||
or
|
||
|
||
```
|
||
sudo rpm -i apidash-<fullname>.rpm
|
||
```
|
||
|
||
or
|
||
|
||
```
|
||
sudo yum localinstall ./apidash-<fullname>.rpm
|
||
```
|
||
|
||
Launch API Dash via `apidash` command or by clicking on the API Dash app icon.
|
||
|
||
### Arch-based Linux Distributions (Manjaro, Arch Linux, etc.)
|
||
|
||
Download the `.deb` file from the [latest release](https://github.com/foss42/apidash/releases/latest) corresponding to your CPU architecture (x86_64/amd64 or arm64/aarch64).
|
||
|
||
First we have to convert the .deb file to .tar.xz file using the following commands.
|
||
|
||
1. Install debtap using the following command.
|
||
```
|
||
yay -S debtap
|
||
```
|
||
|
||
2. Initialize `debtap` using the following command.
|
||
```
|
||
sudo debtap -u
|
||
```
|
||
|
||
3. Convert the .deb file to .tar.xz file using the following command.
|
||
```
|
||
sudo debtap /path/to/apidash-<fullname>.deb
|
||
```
|
||
4. Once converted, install the resulting .tar.xz file using the following command.
|
||
```
|
||
sudo pacman -U apidash-<fullname>.tar.xz
|
||
```
|
||
|
||
Note: Replace `/path/to/apidash-<fullname>.deb` with the path to the downloaded .deb file.
|
||
|
||
Launch API Dash via `apidash` command or by clicking on the API Dash app icon.
|