| 1 | <img src="https://single-spa.js.org/img/logo-white-bgblue.svg" width="50" height="50">
|
| 2 |
|
| 3 | [](https://www.npmjs.org/package/single-spa)
|
| 4 | [](https://travis-ci.org/single-spa/single-spa)
|
| 5 | [](https://www.jsdelivr.com/package/npm/single-spa)
|
| 6 |
|
| 7 | # single-spa
|
| 8 |
|
| 9 | [Join the chat on Slack](https://join.slack.com/t/single-spa/shared_invite/enQtODAwNTIyMzc4OTE1LWUxMTUwY2M1MTY0ZGMzOTUzMGNkMzI1NzRiYzYwOWM1MTEzZDM1NDAyNWM3ZmViOTAzZThkMDcwMWZmNTFmMWQ)
|
| 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-angular1), [Angular](https://github.com/single-spa/single-spa-angular2), [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 | ## Documentation
|
| 23 |
|
| 24 | You can find the single-spa documentation [on the website](https://single-spa.js.org/).
|
| 25 |
|
| 26 | Check out the [Getting Started](https://single-spa.js.org/docs/getting-started-overview.html) page for a quick overview.
|
| 27 |
|
| 28 | ## Demo and examples
|
| 29 |
|
| 30 | Please see the [examples page](https://single-spa.js.org/docs/examples.html) on the website.
|
| 31 |
|
| 32 | ## Want to help?
|
| 33 |
|
| 34 | Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our
|
| 35 | guidelines for [contributing](https://single-spa.js.org/docs/contributing-overview.html) on the [single-spa website](https://single-spa.js.org).
|
| 36 |
|
| 37 | ## Contributing
|
| 38 |
|
| 39 | 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.
|
| 40 |
|
| 41 | ### [Code of Conduct](https://single-spa.js.org/docs/code-of-conduct.html)
|
| 42 |
|
| 43 | 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.
|
| 44 |
|
| 45 | ### [Contributing Guide](https://single-spa.js.org/docs/contributing-overview.html)
|
| 46 |
|
| 47 | 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.
|