https://github.com/orchy-mfe/orchy-core
Core repository of the Orchy project
https://github.com/orchy-mfe/orchy-core
hacktoberfest microfrontends orchestrator typescript webcomponent
Last synced: 12 months ago
JSON representation
Core repository of the Orchy project
- Host: GitHub
- URL: https://github.com/orchy-mfe/orchy-core
- Owner: orchy-mfe
- License: mit
- Created: 2022-08-06T12:45:18.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T23:10:37.000Z (12 months ago)
- Last Synced: 2025-04-12T02:06:01.847Z (12 months ago)
- Topics: hacktoberfest, microfrontends, orchestrator, typescript, webcomponent
- Language: TypeScript
- Homepage:
- Size: 2.91 MB
- Stars: 22
- Watchers: 2
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# orchy-core
[](https://github.com/orchy-mfe/orchy-core/actions/workflows/pipeline.yml)
Welcome to the `orchy-core` repository, the main one of the `Orchy Project`.
It is a monorepo which includes the following packages:
- @orchy-mfe/back-end: a Fastify backend that can be used to serve orchy's configuration files;
- @orchy-mfe/models: includes the TypeScript models for the orchy's configurations and the Micro Frontends properties;
- @orchy-mfe/page-builder: the library which enables the Server Driven UI;
- @orchy-mfe/spa-adapter: the Web Component's base class that must be extended to trigger the Micro Frontend's bootstrap;
- @orchy-mfe/web-component: the Web Component which embeds the orchestration logics.
In the root level `package.json` are defined the scripts to:
- easily access each package (the one prefixed with `w:`):
- `orchy` development (`build`, `lint`...).
# Contributing
Every contribution is always welcome.
Please, be aware to **always**:
- test what you write;
- update accordingly the [documentation](https://github.com/orchy-mfe/orchy-doc) with your changes.
## Local development
To run it locally, you must:
- install the dependencies
```bash
pnpm i
```
- run the `dev` script
```bash
pnpm dev
```
# Project documentation
You can read the full project documentation [here](https://orchy-mfe.github.io/).