https://github.com/dynamic-framework/dynamic-commons-base-template
https://github.com/dynamic-framework/dynamic-commons-base-template
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dynamic-framework/dynamic-commons-base-template
- Owner: dynamic-framework
- Created: 2024-04-30T15:15:52.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-21T01:20:08.000Z (3 months ago)
- Last Synced: 2025-03-21T02:25:20.125Z (3 months ago)
- Language: TypeScript
- Size: 6.39 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# dynamic-commons-base-template
## Requirements:
- node@20+
- npm@10+
## Setup
1. Change the property name in `package.json` to the name of your commons.
> [!IMPORTANT]
> Remember to use the scope of your organization.
2. Change the scope in the `actions/setup-node@v4` step of `.github/workflows/release-please.yml` to the scope of your organization.
3. Workflow permissions
- If in your repository the actions in `workflow permissions` don't have permission to `create and approve pull request`, create a PAT token with the permissions `repo`, `workflows` and `write packages` and add it as a `repository secret` with the name `RELEASE_PLEASE_TOKEN`.
- If in your repository the actions in `workflow permissions` have permission to `create and approve pull request`, change in `.github/workflows/release-please.yml` `${{ secrets.RELEASE_PLEASE_TOKEN }}` to `${{ secrets.GITHUB_TOKEN }}`
4. To apply the client theme in the storybook change in `.storybook/preview-head.html` the link `` to a link to the theme css in the platform.
## Usage
The best way to use this template is to create a repository from it on GitHub.
```console
npm install @your-scope/your-package-name
or if you want to test our template
npm install @dynamic-framework/dynamic-commons-base-template
```
> [!IMPORTANT]
> Remember that commons includes the framework as a peer dependency, you must install the framework in your widget
## Learn More
Find more information about microfrontends and configuration details on [Modyo Docs](https://docs.modyo.com) & [Modyo Community](https://www.modyo.com/community)