Piral ·

Easily build a next generation portal application. Piral enables you to create a modular frontend application that is extended at runtime with decoupled modules called pilets leveraging a microfrontend architecture. A pilet can be developed independently and ships with the necessary JavaScript and bundled assets.

⚡ A pilet is capable of dynamically extending other pilets or using such extension slots itself. Otherwise, a pilet is quite isolated (developed and handled) and will never destroy your application.

⚠️ This project is still pretty much work in progress.

Getting Started

Creating your own Piral app is as simple as installing Piral as a dependency to your React app:

npm i piral-core

Remark: This package already includes TypeScript declarations. No need to install other packages.

Now you can create a new Piral instance in your code:

import { createInstance } from 'piral-core';

const App = createInstance({
  requestPilets: () => fetch('https://feed.piral.io/api/v1/pilet/sample'),
});

Remark: For all available API options make sure to check out the documentation.

Note: The feed above should only be used for demonstration purposes. Either set up your own feed (more information at feed.piral.io) or your own API / mechanism to serve the modules.

Finally, you can render this Piral instance by using the render function from react-dom:

render((
  <App>
    {content => <Layout>{content}</Layout>}
  </App>
), document.querySelector('#app'));

Alternatively, you can use your new Piral instance anywhere as a component.

Your Piral app can be build with any technology that you like or already use (e.g., Webpack, Parcel, ...). If you are unsure what to you use you may fall back to piral-cli, which (among other things) also contains a build mechanism that should just work 🚀.

Contributing

The main purpose of this repository is to continue to evolve Piral core, making it faster, more powerful, and easier to use. Development of Piral happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Piral.

Code of Conduct

We adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

Contributing Guide

Read our contributing guide to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Piral.

Good First Issues

To help you get your feet wet and get you familiar with our contribution process, we have a list of good first issues that contain bugs which have a relatively limited scope. This is a great place to get started.

License

Piral is released using the MIT license. For more information see the license file.