1 | <img src="https://single-spa.js.org/img/logo-white-bgblue.svg" width="50" height="50">
|
2 |
|
3 | [![npm version](https://img.shields.io/npm/v/single-spa.svg?style=flat-square)](https://www.npmjs.org/package/single-spa)
|
4 | [![](https://data.jsdelivr.com/v1/package/npm/single-spa/badge)](https://www.jsdelivr.com/package/npm/single-spa)
|
5 | [![NPM Downloads](https://badgen.net/npm/dm/single-spa)](https://npmjs.org/package/single-spa)
|
6 |
|
7 | # single-spa
|
8 |
|
9 | [Join the chat on Slack](https://join.slack.com/t/single-spa/shared_invite/zt-mafdeybq-0v1aIm3KKaqyVCT2xeny3Q)
|
10 |
|
11 | [Donate to this project](https://opencollective.com/single-spa)
|
12 |
|
13 | ## A javascript framework for front-end microservices
|
14 |
|
15 | Build micro frontends that coexist and can ([but don't need to](https://single-spa.js.org/docs/faq.html#can-i-use-more-than-one-framework)) be written with their own framework. This allows you to:
|
16 |
|
17 | - [Use multiple frameworks](/docs/single-spa-ecosystem.md#help-for-frameworks) on the same page [without refreshing the page](/docs/applications.md)
|
18 | ([React](https://github.com/single-spa/single-spa-react), [AngularJS](https://github.com/single-spa/single-spa-angularjs), [Angular](https://github.com/single-spa/single-spa-angular), [Ember](https://github.com/single-spa/single-spa-ember), or whatever you're using)
|
19 | - Write new code, possibly with a new framework, without rewriting your existing app
|
20 | - Lazy load code for improved initial load time.
|
21 |
|
22 | ## Sponsors
|
23 |
|
24 | <a href="https://datacamp.com/"><img height="50" alt="DataCamp-Logo" src="https://user-images.githubusercontent.com/5524384/117517708-1047f200-af5a-11eb-8d5d-0997d6df06d6.png"></a>
|
25 | <a href="https://pos.toasttab.com/"><img height="50" alt="Toast-Logo" src="https://user-images.githubusercontent.com/5524384/117516281-eab8e980-af55-11eb-9d3c-baff0c3c86e6.png"></a>
|
26 |
|
27 | ## Documentation
|
28 |
|
29 | You can find the single-spa documentation [on the website](https://single-spa.js.org/).
|
30 |
|
31 | Check out the [Getting Started](https://single-spa.js.org/docs/getting-started-overview.html) page for a quick overview.
|
32 |
|
33 | ## Demo and examples
|
34 |
|
35 | Please see the [examples page](https://single-spa.js.org/docs/examples.html) on the website.
|
36 |
|
37 | ## Want to help?
|
38 |
|
39 | Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our
|
40 | guidelines for [contributing](https://single-spa.js.org/docs/contributing-overview.html) on the [single-spa website](https://single-spa.js.org).
|
41 |
|
42 | ## Contributing
|
43 |
|
44 | 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](https://single-spa.js.org/docs/ecosystem.html) 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.
|
45 |
|
46 | ### [Code of Conduct](https://single-spa.js.org/docs/code-of-conduct.html)
|
47 |
|
48 | Single-spa has adopted a Code of Conduct that we expect project participants to adhere to. Please read [the full text](https://single-spa.js.org/docs/code-of-conduct.html) so that you can understand what actions will and will not be tolerated.
|
49 |
|
50 | ### [Contributing Guide](https://single-spa.js.org/docs/contributing-overview.html)
|
51 |
|
52 | Read our [contributing guide](https://single-spa.js.org/docs/contributing-overview.html) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to single-spa.
|