https://github.com/microcks/microcks-docker-desktop-extension
Docker Desktop extension for running Microcks
https://github.com/microcks/microcks-docker-desktop-extension
api contract-testing docker docker-desktop extension mocking
Last synced: 12 months ago
JSON representation
Docker Desktop extension for running Microcks
- Host: GitHub
- URL: https://github.com/microcks/microcks-docker-desktop-extension
- Owner: microcks
- License: apache-2.0
- Created: 2022-06-14T20:16:45.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-21T20:09:34.000Z (over 1 year ago)
- Last Synced: 2024-10-30T05:42:57.541Z (over 1 year ago)
- Topics: api, contract-testing, docker, docker-desktop, extension, mocking
- Language: TypeScript
- Homepage: https://microcks.io
- Size: 4.39 MB
- Stars: 15
- Watchers: 5
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY-INSIGHTS.yml
- Governance: GOVERNANCE.md
- Roadmap: ROADMAP.md
Awesome Lists containing this project
README
# Microcks Docker Desktop Extension
[](https://github.com/microcks/microcks-docker-desktop-extension/actions)
[](https://hub.docker.com/r/microcks/microcks-docker-desktop-extension/tags)
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://microcks.io/discord-invite/)
[](https://artifacthub.io/packages/search?repo=microcks-uber-image)
[](https://landscape.cncf.io/?item=app-definition-and-development--application-definition-image-build--microcks)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmicrocks%2Fmicrocks-docker-desktop-extension?ref=badge_shield)
This extension simplifies the getting started experience for developers using Microcks in their local environments. This extension will start the components to run a local deployment of Microcks using container images.
For any recommendations, suggestions, feature requests and issue, head over the project's GitHub Issues tracker.
## Build Status
Latest released version is `0.3.1`.
Current development version is `0.3.2`.
#### Fossa license and security scans
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmicrocks%2Fmicrocks-docker-desktop-extension?ref=badge_shield&issueType=license)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmicrocks%2Fmicrocks-docker-desktop-extension?ref=badge_shield&issueType=security)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmicrocks%2Fmicrocks-docker-desktop-extension?ref=badge_small)
#### OpenSSF best practices on Microcks core
[](https://bestpractices.coreinfrastructure.org/projects/7513)
[](https://securityscorecards.dev/viewer/?uri=github.com/microcks/microcks)
## Community
* [Documentation](https://microcks.io/documentation/tutorials/getting-started/)
* [Microcks Community](https://github.com/microcks/community) and community meeting
* Join us on [Discord](https://microcks.io/discord-invite/), on [GitHub Discussions](https://github.com/orgs/microcks/discussions) or [CNCF Slack #microcks channel](https://cloud-native.slack.com/archives/C05BYHW1TNJ)
To get involved with our community, please make sure you are familiar with the project's [Code of Conduct](./CODE_OF_CONDUCT.md).
## Install
Since Docker Desktop v4.10 the extension CLI is included with the standard installation.
To install the extension:
```bash
$ docker extension install microcks/microcks-docker-desktop-extension:latest
```
## Build it locally
Build the extension image locally with `make build-extension`:
```sh
$ make build-extension
docker build --tag=microcks/microcks-docker-desktop-extension:latest .
[...]
=> => naming to docker.io/microcks/microcks-docker-desktop-extension:latest
```
Install the extension using the `docker extension` SDK and command:
```sh
$ docker extension install microcks/microcks-docker-desktop-extension:latest
```
When iterating, use the following command:
```sh
$ make build-extension && docker extension update microcks/microcks-docker-desktop-extension:latest -f
```
or see the option to just develop the frontend locally [here](https://docs.docker.com/desktop/extensions-sdk/dev/test-debug/#hot-reloading-whilst-developing-the-ui).
## Debug
Open Chrome DevTools:
```sh
docker extension dev debug microcks/microcks-docker-desktop-extension:latest
```
Developing the UI
```sh
docker extension dev ui-source microcks/microcks-docker-desktop-extension:latest http://localhost:3000
```
Reset
```sh
docker extension dev reset microcks/microcks-docker-desktop-extension:latest
```
## License
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fmicrocks%2Fmicrocks-docker-desktop-extension?ref=badge_large)