Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/getprimate/primate
A modern dashboard for Kong Gateway admins
https://github.com/getprimate/primate
admin dashboard electron kong kongdash primate
Last synced: 2 months ago
JSON representation
A modern dashboard for Kong Gateway admins
- Host: GitHub
- URL: https://github.com/getprimate/primate
- Owner: getprimate
- License: mit
- Created: 2016-08-24T08:33:56.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-02-07T17:24:40.000Z (11 months ago)
- Last Synced: 2024-08-02T19:38:49.650Z (5 months ago)
- Topics: admin, dashboard, electron, kong, kongdash, primate
- Language: JavaScript
- Homepage: https://www.getprimate.xyz
- Size: 7.89 MB
- Stars: 571
- Watchers: 27
- Forks: 95
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
---
## Version Compatibility
| Primate version | Kong Admin API versions |
|-----------------|-------------------------|
| 1.0.0 - 1.1.0 | `2.7.x` `2.8.x` |
## :package: Download and Install
Builds are available for major desktop operating systems.
#### On Windows
Download the [latest](https://github.com/getprimate/primate/releases/latest) executable setup file and run it.
#### On macOS
Download and open the [latest](https://github.com/getprimate/primate/releases/latest) DMG file, move the app to /Applications.
#### On Linux
Primate is available as AppImage and tar.gz archive for all popular Linux distributions.
- Download the [latest](https://github.com/getprimate/primate/releases/latest) .AppImage.
- Make it executable `$ sudo chmod a+x Primate-version-x64.AppImage`.
- Run Primate `$ ./Primate-version-x64.AppImage`.
_For Ubuntu users:_
Primate can also be installed from the [Snap store](https://snapcraft.io/primate).
```shell
$ sudo snap install primate
```
## :thumbsup: Contribute
There are several ways to support development:
- Provide feedbacks and suggest improvements.
- Contribute to the development with pull requests.
For a complete overview, see the [contributing](CONTRIBUTING.md) guide.
### For Developers
- Requires NodeJs (v16.13.2 or higher) and yarn (v1.22.17 or higher).
- Built with [Electron](https://www.electronjs.org/).
#### Build and Run
Clone the repository, install dependencies and start.
```shell
$ git clone https://github.com/getprimate/primate
$ cd primate
$ yarn install
$ yarn start
```
#### Package the Application
To package the application for your operating system, run:
```shell
$ yarn run compile
$ yarn run dist
```
The binaries will be written to `/dist` directory.
Run `$ yarn run clean` to clean the output directories.
_Currently, compiling to non-native binary is disabled._
## :spiral_notepad: License
MIT License. See [LICENSE](LICENSE).
## :raised_hands: Supporters
