https://github.com/mia-platform/console-sdk
Mia-Platform Console SDK holds all packages that helps to integrate your software with the Mia-Platform ecosystem
https://github.com/mia-platform/console-sdk
mia-platform microfrontend sdk
Last synced: about 1 year ago
JSON representation
Mia-Platform Console SDK holds all packages that helps to integrate your software with the Mia-Platform ecosystem
- Host: GitHub
- URL: https://github.com/mia-platform/console-sdk
- Owner: mia-platform
- License: apache-2.0
- Created: 2023-12-06T13:13:30.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T09:16:48.000Z (over 1 year ago)
- Last Synced: 2024-10-24T16:36:01.492Z (over 1 year ago)
- Topics: mia-platform, microfrontend, sdk
- Language: TypeScript
- Homepage:
- Size: 1.44 MB
- Stars: 10
- Watchers: 2
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Console SDK
[![NPM publish CI][action-status-svg]][github-action]
[![javascript style guide][standard-mia-svg]][standard-mia]
[![Coverage Status][coverall-svg]][coverall-io]
This repository is used to configure your microfrontend, as Mia platform Console extensions, easily
See the specific monorepo readme to using this library
## Monorepo packages
- **Console SDK**: An abstract interface used within helper repositories. [Read more](./packages/console-sdk-microfrontend)
- **Vite helpers**: Used to configure the microfrontend with vite. [Read more](./packages/console-sdk-vite-helpers)
- **Webpack helpers**: Used to configure the microfrontend with webpack. [Read more](./packages/console-sdk-webpack-helpers)
## Install
To use this repository
```bash
npm install @mia-platform/console-sdk-microfrontend
npm install @mia-platform/console-sdk-vite-helpers
npm install @mia-platform/console-sdk-webapack-helpers
```
## Local Development
For local development, you can run:
```bash
pnpm install && pnpm test
```
To run tests on a specific package:
```bash
pnpm --filter
```
or using the prepared script
```bash
pnpm types test
pnpm sdk test
pnpm vh test
pnpm wh test
```
[action-status-svg]: https://github.com/mia-platform/console-sdk/actions/workflows/test.yml/badge.svg
[github-action]: https://github.com/mia-platform/console-sdk/actions/workflows/test.yml
[standard-mia-svg]: https://img.shields.io/badge/code_style-standard--mia-orange.svg
[standard-mia]: https://github.com/mia-platform/eslint-config-mia
[coverall-svg]: https://coveralls.io/repos/github/mia-platform/console-sdk/badge.svg
[coverall-io]: https://coveralls.io/github/mia-platform/console-sdk