vicious-gold
vicious-gold2mo ago

Reuseing resources across different projects - microservice architecture

Hi there, I'm pretty excited about using refine. I have tinkered around with it in one of my projects. But I do have a usecase which I do not see covered. Let's assume you have multiple microservices and want to provide a small frontend for each of the microservices. So this can be deployed independently. Now you also want to have a complete dashboard which spans multiple microservices and you want to make use of the already created resources in the individual frontends. In some occassions you want to add additional references, like links between resources. How can I do this with refine? I want to reuse as much as possible. When I simply try to import the List component from another refine project, I end up with an error:
Attempted import error: 'App' is not exported from '__barrel_optimize__?names=App,notification!=!antd' (imported as 'ps').
Attempted import error: 'App' is not exported from '__barrel_optimize__?names=App,notification!=!antd' (imported as 'ps').
This might be trivial but I'm grateful for any suggestions and think this is a common use case.
9 Replies
kapa.ai
kapa.ai2mo ago
Hi @jonas. I'm kapa.ai, your friendly support bot. I will try to answer your question by searching through the knowledge base. :wave: ---------------------- Refine is designed to be highly customizable and flexible, which makes it suitable for a variety of use cases, including the one you've described. However, the specific error you're encountering seems to be related to the way you're trying to import components across different projects. Refine allows you to define resources in your application using the resources prop in the <Refine /> component. Each resource object in the resources array represents a RESTful route in your app and contains properties related to the resource name, options, and intended actions. For example:
{
"name": "canvases",
"list": "/canvases",
"show": "/canvases/show/:id"
}
{
"name": "canvases",
"list": "/canvases",
"show": "/canvases/show/:id"
}
(Source: Refine Blog (https://refine.dev/blog/refine-pixels-3#refine-s-resources-prop)) You can also integrate Refine into an existing project by installing the @refinedev/core package and importing the Refine component into your application. Once imported, the Refine component provides the necessary context for all child components to work with Refine hooks and components.
import { Refine } from "@refinedev/core";
import dataProvider from "@refinedev/simple-rest";

const API_URL = "<https://api.fake-rest.refine.dev";>

function App() {
return (
<Refine dataProvider={dataProvider(API_URL)}>
{/* You can use Refine hooks inside here */}
<ComponentWithRefineHooks />
</Refine>
);
}
import { Refine } from "@refinedev/core";
import dataProvider from "@refinedev/simple-rest";

const API_URL = "<https://api.fake-rest.refine.dev";>

function App() {
return (
<Refine dataProvider={dataProvider(API_URL)}>
{/* You can use Refine hooks inside here */}
<ComponentWithRefineHooks />
</Refine>
);
}
(Source: Refine Docs (https://refine.dev/docs/guides-concepts/usage-with-existing-projects)) However, directly importing components from one Refine project to another might not work as expected due to the way Refine sets up its context and hooks. Each Refine application maintains its own context, and components that rely on this context might not function correctly if imported into a different Refine application. For your use case, you might want to consider creating shared components or hooks that can be imported across different projects. These shared elements should not rely directly on the Refine context but should instead expose props or use callbacks to interact with the Refine context in each individual application. If you're still encountering issues, it might be helpful to review the Refine documentation (https://refine.dev/docs) or seek help from the Refine community. ---------------------- Note: you can ask me a follow up question by @ mentioning me again :speech_balloon: ----------------------
kapa.ai
kapa.ai2mo ago
<@410562454255304704> kapa.ai is still learning and improving, please let us know how it did by reacting below
vicious-gold
vicious-gold2mo ago
@kapa.ai I think shared components is exactly what I want to do. Can you provide me with a minimal example? What I did was I imported JobsList: React.FC<IResourceComponentsProps> into my other refine application and assumed that would work. @kapa.ai
kapa.ai
kapa.ai2mo ago
Let me check the knowledge base for you. One moment! :books: Sorry @jonas, I seem to be having a bit of trouble. Don't worry though, I've pinged my support and they will try to fix me up! :technologist: Perhaps try again in 15mins?
vicious-gold
vicious-gold2mo ago
@kapa.ai
kapa.ai
kapa.ai2mo ago
Let me check the knowledge base for you. One moment! :books: Sorry @jonas, I seem to be having a bit of trouble. Don't worry though, I've pinged my support and they will try to fix me up! :technologist: Perhaps try again in 15mins?
vicious-gold
vicious-gold2mo ago
@kapa.ai I think shared components is exactly what I want to do. Can you provide me with a minimal example? What I did was I imported JobsList: React.FC<IResourceComponentsProps> into my other refine application and assumed that would work.
kapa.ai
kapa.ai2mo ago
Let me check the knowledge base for you. One moment! :books: ---------------------- Creating shared components in Refine involves creating React components that can be used across different projects. These components should be designed to accept props for any data they need to display or any callbacks they need to interact with the rest of the application. Here's a simple example of a shared component that displays a list of items:
// SharedComponent.tsx
import React from 'react';

interface SharedComponentProps {
items: Array<{ id: string, name: string }>;
}

export const SharedComponent: React.FC<SharedComponentProps> = ({ items }) => {
return (
<ul>
{items.map(item => (
<li key={item.id}>{item.name}</li>
))}
</ul>
);
};
// SharedComponent.tsx
import React from 'react';

interface SharedComponentProps {
items: Array<{ id: string, name: string }>;
}

export const SharedComponent: React.FC<SharedComponentProps> = ({ items }) => {
return (
<ul>
{items.map(item => (
<li key={item.id}>{item.name}</li>
))}
</ul>
);
};
You can then use this component in your Refine application like so:
// App.tsx
import { SharedComponent } from './SharedComponent';
import { useList } from '@refinedev/core';

export const App: React.FC = () => {
const { data: products } = useList({ resource: "products" });

return (
<div>
<h1>Products</h1>
<SharedComponent items={products?.data || []} />
</div>
);
};
// App.tsx
import { SharedComponent } from './SharedComponent';
import { useList } from '@refinedev/core';

export const App: React.FC = () => {
const { data: products } = useList({ resource: "products" });

return (
<div>
<h1>Products</h1>
<SharedComponent items={products?.data || []} />
</div>
);
};
In this example, the SharedComponent is a simple list component that accepts an array of items as a prop. The App component uses the useList hook from Refine to fetch a list of products from the server, then passes this data to the SharedComponent for display. This way, the SharedComponent is not directly dependent on the Refine context and can be used in any React application, not just those built with Refine. Remember to export your shared components from a central index file in your shared components library, so they can be easily imported into any project. Please note that this is a simplified example. Depending on your needs, you might need to create more complex shared components, or use additional hooks and context providers from Refine. Always refer to the Refine documentation (https://refine.dev/docs) for more detailed information and examples. ---------------------- Note: you can ask me a follow up question by @ mentioning me again :speech_balloon: ----------------------
kapa.ai
kapa.ai2mo ago
<@410562454255304704> kapa.ai is still learning and improving, please let us know how it did by reacting below