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

Migrate api-dash to apidash

Browse Source
This commit is contained in:
Ankit Mahato
2023-08-27 18:23:49 +05:30
parent 5405b8f37a
commit 32b8358cd8
6 changed files with 26 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
CONTRIBUTING.md
View File

@ -4,10 +4,10 @@ We value your participation in this open source project. This page will give you
You can contribute to the project in any or all of the following ways: You can contribute to the project in any or all of the following ways:
- [Ask a question](https://github.com/foss42/api-dash/discussions) - [Ask a question](https://github.com/foss42/apidash/discussions)
- [Submit a bug report](https://github.com/foss42/api-dash/issues/new/choose) - [Submit a bug report](https://github.com/foss42/apidash/issues/new/choose)
- [Request a new feature](https://github.com/foss42/api-dash/issues/new/choose) - [Request a new feature](https://github.com/foss42/apidash/issues/new/choose)
- [Suggest ways to improve the developer experience of an existing feature](https://github.com/foss42/api-dash/issues/new/choose) - [Suggest ways to improve the developer experience of an existing feature](https://github.com/foss42/apidash/issues/new/choose)
- Add documentation - Add documentation
- Add a new feature, resolve an existing issue or add a new test to the project. (Goto [Code Contribution Guidelines](#code-contribution-guidelines)). - Add a new feature, resolve an existing issue or add a new test to the project. (Goto [Code Contribution Guidelines](#code-contribution-guidelines)).
@ -27,11 +27,11 @@ We currently do not accept PRs that involve:
### Resolving an existing issue / Adding a requested feature ### Resolving an existing issue / Adding a requested feature
You can find all existing issues [here](https://github.com/foss42/api-dash/issues). A good place to start is to take a look at ["good first issues"](https://github.com/foss42/api-dash/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22). You can find all existing issues [here](https://github.com/foss42/apidash/issues). A good place to start is to take a look at ["good first issues"](https://github.com/foss42/apidash/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
**Step 1** - Identify the issue you want to work on. **Step 1** - Identify the issue you want to work on.
**Step 2** - Comment on the issue so that we can discuss how to approach and solve the problem. **Step 2** - Comment on the issue so that we can discuss how to approach and solve the problem.
**Step 3** - Fork the [`foss42/api-dash`](https://github.com/foss42/api-dash) repo to your account. **Step 3** - Fork the [`foss42/apidash`](https://github.com/foss42/apidash) repo to your account.
**Step 4** - Create a new branch in your fork and name it `add-feature-xyz` or `resolve-issue-xyz`. **Step 4** - Create a new branch in your fork and name it `add-feature-xyz` or `resolve-issue-xyz`.
**Step 5** - Run API Dash locally (More details [here](#how-to-run-api-dash-locally)). **Step 5** - Run API Dash locally (More details [here](#how-to-run-api-dash-locally)).
**Step 6** - Make code changes in the branch. **Step 6** - Make code changes in the branch.
@ -41,8 +41,8 @@ You can find all existing issues [here](https://github.com/foss42/api-dash/issue
### Adding a new feature ### Adding a new feature
**Step 1** - Open an [issue](https://github.com/foss42/api-dash/issues/new/choose) so that we can discuss on the new feature. **Step 1** - Open an [issue](https://github.com/foss42/apidash/issues/new/choose) so that we can discuss on the new feature.
**Step 2** - Fork the [`foss42/api-dash`](https://github.com/foss42/api-dash) repo to your account. **Step 2** - Fork the [`foss42/apidash`](https://github.com/foss42/apidash) repo to your account.
**Step 3** - Create a new branch in your fork and name it `add-feature-xyz`. **Step 3** - Create a new branch in your fork and name it `add-feature-xyz`.
**Step 4** - Run API Dash locally (More details [here](#how-to-run-api-dash-locally)). **Step 4** - Run API Dash locally (More details [here](#how-to-run-api-dash-locally)).
**Step 5** - Make the necessary code changes required to implement the feature in the branch. **Step 5** - Make the necessary code changes required to implement the feature in the branch.
@ -61,7 +61,7 @@ You can contribute by adding missing/new tests for:
- Services (`lib/services/`). - Services (`lib/services/`).
**Step 1** - Identify the test you want to add or improve. **Step 1** - Identify the test you want to add or improve.
**Step 2** - Fork the [`foss42/api-dash`](https://github.com/foss42/api-dash) repo to your account. **Step 2** - Fork the [`foss42/apidash`](https://github.com/foss42/apidash) repo to your account.
**Step 3** - Create a new branch in your fork and name it `add-test-xyz`. **Step 3** - Create a new branch in your fork and name it `add-test-xyz`.
**Step 4** - Add the test to an existing test file or create a new test file in the `test` folder. **Step 4** - Add the test to an existing test file or create a new test file in the `test` folder.
**Step 5** - Run the tests locally (More details [here](#how-to-run-tests)). **Step 5** - Run the tests locally (More details [here](#how-to-run-tests)).
@ -127,7 +127,6 @@ $ flutter doctor -v
``` ```
flutter run --enable-experiment=records flutter run --enable-experiment=records
``` ```
**Note**: In case you encounter an invalid Dart Package name error on your first run, rename the project's folder name from "api-dash" to "apidash" and re-run.
### How to run tests? ### How to run tests?

8
INSTALLATION.md
View File

@ -1,13 +1,13 @@
# Installation Instructions # Installation Instructions
## Windows ## Windows
Download the latest Windows Installer (64 bit) from [here](https://github.com/foss42/api-dash/releases/latest) 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 and follow the step by step installation wizard. To install it, simply double click on the installer and follow the step by step installation wizard.
## MacOS ## MacOS
Download the latest MacOS Installer (Universal - Intel and Apple Silicon) from [here](https://github.com/foss42/api-dash/releases/latest) 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.** **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.**
@ -46,7 +46,7 @@ Note: The next step has to be performed twice so that macOS adds the app to whit
### Debian-based Linux Distributions (Debian, Ubuntu, Linux Mint, etc.) ### Debian-based Linux Distributions (Debian, Ubuntu, Linux Mint, etc.)
Download the `.deb` file from the [latest release](https://github.com/foss42/api-dash/releases/latest) corresponding to you CPU architecture (x64/amd64 or arm64). 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. `cd` to the Downloads folder and execute the following command to install API Dash.
@ -64,7 +64,7 @@ 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.) ### Red Hat-based Linux Distributions (Fedora, Rocky, AlmaLinux, CentOS, RHEL, etc.)
Download the `.rpm` file from the [latest release](https://github.com/foss42/api-dash/releases/latest) corresponding to you CPU architecture (x86_64 or aarch64/arm64). 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. `cd` to the Downloads folder and execute the following command to install API Dash.

20
README.md
View File

@ -23,21 +23,21 @@ API Dash can be downloaded from the links below:
<tr> <tr>
<td>macOS</td> <td>macOS</td>
<td><code>.dmg</code></td> <td><code>.dmg</code></td>
<td><a href="https://github.com/foss42/api-dash/blob/main/INSTALLATION.md#macos">Link</a></td> <td><a href="https://github.com/foss42/apidash/blob/main/INSTALLATION.md#macos">Link</a></td>
<td>Apple Silicon & Intel</td> <td>Apple Silicon & Intel</td>
<td><a href="https://bit.ly/44wmazf">Link</a></td> <td><a href="https://bit.ly/44wmazf">Link</a></td>
</tr> </tr>
<tr> <tr>
<td>Windows</td> <td>Windows</td>
<td><code>.exe</code></td> <td><code>.exe</code></td>
<td><a href="https://github.com/foss42/api-dash/blob/main/INSTALLATION.md#windows">Link</a></td> <td><a href="https://github.com/foss42/apidash/blob/main/INSTALLATION.md#windows">Link</a></td>
<td>64-bit</td> <td>64-bit</td>
<td><a href="https://bit.ly/424ExKb">Link</a></td> <td><a href="https://bit.ly/424ExKb">Link</a></td>
</tr> </tr>
<tr> <tr>
<td rowspan=4>Linux</td> <td rowspan=4>Linux</td>
<td rowspan=2><code>.deb</code></td> <td rowspan=2><code>.deb</code></td>
<td rowspan=2><a href="https://github.com/foss42/api-dash/blob/main/INSTALLATION.md#debian-based-linux-distributions-debian-ubuntu-linux-mint-etc">Link</a></td> <td rowspan=2><a href="https://github.com/foss42/apidash/blob/main/INSTALLATION.md#debian-based-linux-distributions-debian-ubuntu-linux-mint-etc">Link</a></td>
<td>amd64</td> <td>amd64</td>
<td><a href="https://bit.ly/44sWPq2">Link</a></td> <td><a href="https://bit.ly/44sWPq2">Link</a></td>
</tr> </tr>
@ -47,7 +47,7 @@ API Dash can be downloaded from the links below:
</tr> </tr>
<tr> <tr>
<td rowspan=2><code>.rpm</code></td> <td rowspan=2><code>.rpm</code></td>
<td rowspan=2><a href="https://github.com/foss42/api-dash/blob/main/INSTALLATION.md#red-hat-based-linux-distributions-fedora-rocky-almalinux-centos-rhel-etc">Link</a></td> <td rowspan=2><a href="https://github.com/foss42/apidash/blob/main/INSTALLATION.md#red-hat-based-linux-distributions-fedora-rocky-almalinux-centos-rhel-etc">Link</a></td>
<td>x86_64</td> <td>x86_64</td>
<td><a href="https://bit.ly/417gWHe">Link</a></td> <td><a href="https://bit.ly/417gWHe">Link</a></td>
</tr> </tr>
@ -62,7 +62,7 @@ API Dash can be downloaded from the links below:
Demo Video on Youtube - [Link](https://youtu.be/IQlrgpNpS2s) (In case there is an error loading the embedded video below 👇) Demo Video on Youtube - [Link](https://youtu.be/IQlrgpNpS2s) (In case there is an error loading the embedded video below 👇)
https://github.com/foss42/api-dash/assets/615622/fccc569e-3152-47be-9f94-ceb851ee85a0 https://github.com/foss42/apidash/assets/615622/fccc569e-3152-47be-9f94-ceb851ee85a0
## List of Features ## List of Features
@ -101,16 +101,16 @@ Visit [CHANGELOG.md](CHANGELOG.md)
## Provide Feedback, Report Bugs & Request New Features ## Provide Feedback, Report Bugs & Request New Features
Just click on the [Issue tab](https://github.com/foss42/api-dash/issues) to raise a new issue in this repo. Just click on the [Issue tab](https://github.com/foss42/apidash/issues) to raise a new issue in this repo.
## Contribute to API Dash ## Contribute to API Dash
You can contribute to API Dash in any or all of the following ways: You can contribute to API Dash in any or all of the following ways:
- [Ask a question](https://github.com/foss42/api-dash/discussions) - [Ask a question](https://github.com/foss42/apidash/discussions)
- [Submit a bug report](https://github.com/foss42/api-dash/issues/new/choose) - [Submit a bug report](https://github.com/foss42/apidash/issues/new/choose)
- [Request a new feature](https://github.com/foss42/api-dash/issues/new/choose) - [Request a new feature](https://github.com/foss42/apidash/issues/new/choose)
- [Suggest ways to improve the developer experience of an existing feature](https://github.com/foss42/api-dash/issues/new/choose) - [Suggest ways to improve the developer experience of an existing feature](https://github.com/foss42/apidash/issues/new/choose)
- Add documentation - Add documentation
- To add a new feature, resolve an existing issue or add a new test to the project, check out our [Contribution Guidelines](CONTRIBUTING.md). - To add a new feature, resolve an existing issue or add a new test to the project, check out our [Contribution Guidelines](CONTRIBUTING.md).

2
assets/intro.md
View File

@ -40,7 +40,7 @@ Using API Dash, you can easily create & customize your API requests, visually in
7. Notification on save, download and any other user action (UX improvement). 7. Notification on save, download and any other user action (UX improvement).
8. Linux builds are now available for API Dash (.deb & .rpm) 8. Linux builds are now available for API Dash (.deb & .rpm)
.. and various bug fixes & performance improvements. View full changelog [here](https://github.com/foss42/api-dash/blob/main/CHANGELOG.md). .. and various bug fixes & performance improvements. View full changelog [here](https://github.com/foss42/apidash/blob/main/CHANGELOG.md).
#br #br
#br #br

2
lib/consts.dart
View File

@ -6,7 +6,7 @@ import 'package:google_fonts/google_fonts.dart';
import 'package:davi/davi.dart'; import 'package:davi/davi.dart';
const kDiscordUrl = "https://bit.ly/heyfoss"; const kDiscordUrl = "https://bit.ly/heyfoss";
const kGitUrl = "https://github.com/foss42/api-dash"; const kGitUrl = "https://github.com/foss42/apidash";
const kIssueUrl = "$kGitUrl/issues"; const kIssueUrl = "$kGitUrl/issues";
final kIsMacOS = !kIsWeb && Platform.isMacOS; final kIsMacOS = !kIsWeb && Platform.isMacOS;

2
test/request_models.dart
View File

@ -45,7 +45,7 @@ const requestModelGet4 = RequestModel(
/// GET request model with headers /// GET request model with headers
const requestModelGet5 = RequestModel( const requestModelGet5 = RequestModel(
id: 'get5', id: 'get5',
url: 'https://api.github.com/repos/foss42/api-dash', url: 'https://api.github.com/repos/foss42/apidash',
method: HTTPVerb.get, method: HTTPVerb.get,
requestHeaders: [ requestHeaders: [
KVRow('Authorization', 'Bearer XYZ'), KVRow('Authorization', 'Bearer XYZ'),