single-spa's Introduction

single-spa

Join the chat on Slack

A javascript metaframework

Build micro frontends that coexist and can each be written with their own framework. This allows you to:

Use multiple frameworks on the same page without refreshing the page (React, AngularJS, Angular, Ember, or whatever you're using)
Write code using a new framework, without rewriting your existing app
Lazy load code for improved initial load time.

Documentation

You can find the single-spa documentation on the website.

Check out the Getting Started page for a quick overview.

Demo and examples

A live demo is available and the source code for that demo is available in the single-spa-examples repository.

Also, you can check out a simple webpack starter project which is simpler and hopefully easier to get started with.

Want to help?

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for contributing on the single-spa website.

Project roadmap

We're trying out github's Projects feature (here) and are keeping it up-to-date with the fancy things in the works for single-spa.

The main purpose of this repository is to continue to evolve single-spa, making it better and easier to use. Development of single-spa, and the single-spa ecosystem 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 single-spa.

Code of Conduct

Single-spa has 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 single-spa.

Recommend Projects