Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/robhameetman/micro-fe

๐Ÿš€ A collection of NPM initializers for bootstrapping micro-frontend solutions.
https://github.com/robhameetman/micro-fe

lerna-monorepo micro-frontends nodejs npm pre-alpha project-templates typescript

Last synced: about 1 month ago
JSON representation

๐Ÿš€ A collection of NPM initializers for bootstrapping micro-frontend solutions.

Awesome Lists containing this project

README

        

![@micro-fe][header]

# ๐Ÿ“ฆ @micro-fe

This project is a curated collection of NPM initializers for generating Micro-frontends
and micro-frontend structural patterns.

- [๐Ÿ“ฆ @micro-fe](#%f0%9f%93%a6-micro-fe)
- [๐Ÿ’ผ Getting Started](#%f0%9f%92%bc-getting-started)
- [๐Ÿ“š Prerequisites](#%f0%9f%93%9a-prerequisites)
- [๐Ÿ“ฒ Installing](#%f0%9f%93%b2-installing)
- [๐Ÿ›ฅ Deployment](#%f0%9f%9b%a5-deployment)
- [๐Ÿงพ Project Dependencies](#%f0%9f%a7%be-project-dependencies)
- [๐Ÿท Versioning](#%f0%9f%8f%b7-versioning)
- [๐Ÿ“œ Authors](#%f0%9f%93%9c-authors)
- [๐Ÿ“„ License](#%f0%9f%93%84-license)

## ๐Ÿ’ผ Getting Started

The instructions below will get you a copy of the project up and running on your
local machine for development and testing purposes. See deployment for notes on
how to deploy the project on a live system.

To use this project to bootstrap your micro-frontend project, run the following
in your terminal:

```bash
npm init @micro-fe
```

### ๐Ÿ“š Prerequisites

What things you need to install the software and how to install them

- Node v12+
- NPM v6+

### ๐Ÿ“ฒ Installing

To install the project, clone and build the repo, then use `npm` to install
dependencies for each package.

```bash
git clone [email protected]:micro-fe.git
cd micro-fe
npm i
```

## ๐Ÿ›ฅ Deployment

Each package is versioned and deployed independently with `npm`:

```bash
npm version patch
npm publish
```

## ๐Ÿงพ Project Dependencies

- [TypeScript](https://www.typescriptlang.org/) - Implementation language
- [NPM](https://www.npmjs.com/) - Dependency Management

## ๐Ÿท Versioning

I use [SemVer](http://semver.org/) for versioning. For the versions available,
see the [tags on this repository](https://github.com/RobHameetman/micro-fe/tags/).

## ๐Ÿ“œ Authors

- **Robert Hameetman** - __

See also the list of [contributors](https://github.com/RobHameetman/micro-fe/graphs/contributors) who participated in this project.

## ๐Ÿ“„ License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

[header]: /.github/readme-root.png '@micro-fe'