Skip to content

Latest commit

 

History

History
75 lines (53 loc) · 5.45 KB

README.md

File metadata and controls

75 lines (53 loc) · 5.45 KB

NX micro-frontend setup guide

Github CI github CD codecov CodeQL

All Contributors

This guide will provides step by step to build a web micro-frontend application structured with NX workspace. There are two different templates. One for application and one for library. Your project will most likely be splitted into multiple workspaces that are managed by different team building up their own micro-frontend applications and libraries to interface with the host.

Setup environment

Refers to the Environment documentation to ensure you have the correct toolchain installed before carrying out this guide.

Setup Pre-commit validation

While working alone or in a team, it is good practice to setup pre-commit validation of the code and commit message. This ensure that your project has constant buildable codebase and consistant commit. The CGit Hooks guide will help you to set that up.

Micro frontend application

The Angular MFE guide will help you bootstrap you own Angular MFE similar to this one.

DotNetCore WebApi

The nx dotnet guide will help you bootstrap you own DotNetCore webapi.

Setup CI / CD

Different team uses different process adapted for their needs, but typically, you will have some sort of SDLC that include Brnaching and Pull request. Following this workflow, you will most likely use also Continuous integration and in case you don´t, then you should !

The following guide will helps you setup a CI / CD pipeline with Github actions. Refers to github for more information if this doesn´t fit your needs.

Packages upgrade

From time to time, you will need to update / upgrade your packages to a newer version due to security fixes, support changes or new features adoption. The Packages migration guide provides exemples of commands to upgrade the workspace, runtime and dev packages.

Wants to learn mode ?

While this guide is tailored for our needs, this is based on many good blog articles and tools documentation listed in a Reading list.

Contributors

Bruno DUVAL
Bruno DUVAL
💻 📖 📆 👀 ⚠️ 🌍
Add your contributions

Powered by

  _   _ _            _                   _____                      ______               
 | \ | (_)          | |                 / ____|                    |  ____|              
 |  \| |_ _ __   ___| |_ ___  ___ _ __ | (___   _____   _____ _ __ | |__ ___  _   _ _ __ 
 | . ` | | '_ \ / _ \ __/ _ \/ _ \ '_ \ \___ \ / _ \ \ / / _ \ '_ \|  __/ _ \| | | | '__|
 | |\  | | | | |  __/ ||  __/  __/ | | |____) |  __/\ V /  __/ | | | | | (_) | |_| | |   
 |_| \_|_|_| |_|\___|\__\___|\___|_| |_|_____/ \___| \_/ \___|_| |_|_|  \___/ \__,_|_|