Welcome to Mia-Platform documentation

In this repository you can find the official Mia-Platform Documentation.

Open Source 💻😎

We believe in the open source community, we think it is important to give back and for this reason we have always supported the CNCF. Check out our open source projects.

• MongoDB CRUD Service: a lightweight application that exposes an HTTP Interface to perform CRUD operations on MongoDB collections;
• micro-lc: a micro-frontend orchestrator;
• kube-green: a k8s operator that helps you reduce CO2 emissions while saving energy and money;
• Rönd: an open source RBAC solution to manage authorization on custom applications;
• Mia-Platform Marketplace: our marketplace central registry.

Find out more 🔥✨

Local Development

The documentation site is built using Docusaurus 2; to develop locally you need:

• Node 16+

To setup node, please if possible try to use nvm, so you can manage multiple versions easily.

This is a React application and uses Yarn as a package manager.
Once you have installed Yarn, you can go inside the directory of the project and install all dependencies simply running:

yarn install

This command rapidly launch the site on http://localhost:3000 and open up a browser window:

yarn start

After this command, every time you save the site will be automatically live updated.

To test the site built you have to build the project and runs it on a local server with following commands:

yarn build
yarn serve

This command starts a local development server, the site will be reachable on http://localhost:3000 window. To see changes you have to restart the server.

⚠️ The Search is configured to not working locally.

How to contribute

Read related contribution guide.