Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md with running FEC locally instructions #2139

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md with running FEC locally instructions #2139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions packages/components/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,21 @@ transform: (importName) =>`@redhat-cloud-services/frontend-components/${FECMappe
transform: (importName) =>`@redhat-cloud-services/frontend-components/esm/${FECMapper[importName] || importName}`,

```
## Running with another applicaiton

This set up should work with most applications but individual apps may have dependency conflicts.
In this example Insights-Inventory-Frontend will be used
- In FEC, navigate to packages/components -> here run `npm link`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this not be done within the dist folder?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I hadnt done so, I followed those instructions exactly and was able to get it to work with three different repos

Copy link
Member

@bastilian bastilian Jan 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adonispuente Please doublecheck that you do not have any leftover assets within the packages/components folder for example. Within these folders there should only be folders like src/lib or docs, If you see ".js" files they are probably old and outdated. This could be why it still works for you, because not linking it from within the dist folder doesn't work for me. ;)

- In Inventory root, run `npm link @redhat-cloud-services/frontend-components`
- Verify it actually linked with `ls -l node_modules/@redhat-cloud-services/frontend-components`
- In Inventorys fec.config.js , attach
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Hyperkid123 Maybe we could add this to the fec CLIs config and enable it automagically when it sees any symlink in the @redhat-cloud-services packages?

`resolve: {
modules: ['...', resolve(__dirname, 'node_modules'), 'node_modules'],
},`
after module federation (FEC packages are looking for node modules in its own context and not the actual app, this overrides it)
- `npm run build`In Inventory
- `npm run start:proxy` also in Inventory -> Done


## Documentation Links

Expand Down
Loading