|
1 | | -# Scully, the Angular SSG |
| 1 | +# Scully |
| 2 | + |
| 3 | +[](http://commitizen.github.io/cz-cli/) |
| 4 | + |
| 5 | +The best way to build the fastest Angular apps. Scully is a static site generator for Angular projects looking to embrace the JAMStack. |
| 6 | + |
| 7 | +- [Getting Started](docs/getting-started.md) |
| 8 | +- [Full Documentation](docs/scully.md) |
| 9 | +- [Live Demo](https://www.youtube.com/watch?v=Sh37rIUL-d4) (_from Dec 16, 2019_) |
| 10 | + |
| 11 | +# What is Scully? |
| 12 | +Scully pre-renders each page in your app to plain HTML & CSS. To do this, Scully uses machine learning techniques to find |
| 13 | +all of the routes in your project. Scully then visits each route, rendering the view and saving it to an HTML file. |
| 14 | + |
| 15 | +You can then ship all of those HTML files to production. Each view in your app can now be delivered to your users in just |
| 16 | +a few KBs, as opposed to the hundreds/thousands of KBs require to download your entire Angular app. |
| 17 | + |
| 18 | +Your app appears INSTANTLY on any device (including mobile 3G). |
| 19 | + |
| 20 | +Once the fully-rendered HTML arrives/appears on the user's view, your Angular app will then load and bootstrap on top of |
| 21 | +the existing view. This means that Scully gives you the best of both worlds: |
| 22 | + |
| 23 | +1. The ability to pre-render your entire app to the most base form of HTML & CSS. |
| 24 | +2. The ability to still have a full powered SPA written in Angular. |
| 25 | + |
| 26 | +When your app is pre-rendered, users no longer wait until all the JavaScript has downloaded, parsed and executed before |
| 27 | +they can see and interact with your website. They can immediately begin to see and interact with the page. When your page |
| 28 | +is IMMEDIATELY available, you will have less abandoned sessions and a much higher conversion rate on your website. |
| 29 | + |
| 30 | +This also means that you may not need to ship your backend to production. Because the view is pre-rendered and the |
| 31 | +data is fetched at build time, all views that can run without the backend in prod CAN run without the backend in prod. |
| 32 | +The security and cost implications to that fact can be mind blowing when you think about them. |
| 33 | + |
| 34 | +For those wanting to know more about this process, please read the [Getting Started](docs/getting-started.md) guide. For |
| 35 | +those who want to know more about the theory behind pre-rendering JavaScript SPAs, our friends at [Netlify](https://netlify.com) |
| 36 | +wrote a [free book about the JAMStack](https://www.netlify.com/pdf/oreilly-modern-web-development-on-the-jamstack.pdf). |
| 37 | +Check that out today. |
| 38 | + |
| 39 | +## Core Team |
| 40 | + |
| 41 | +| Aaron Frost | Sander Elias | Jorge Cano | Andres Villanueva | |
| 42 | +| ------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------| |
| 43 | +|  |  |  |  | |
| 44 | +| [aaronfrost](https://github.com/aaronfrost) | [SanderElias](https://github.com/SanderElias) | [jorgeucano](https://github.com/jorgeucano) | [villanuevand](https://github.com/villanuevand) | |
| 45 | + |
| 46 | + |
| 47 | +#### Created by |
| 48 | + |
| 49 | + |
| 50 | +***HeroDevs. LLC*** |
2 | 51 |
|
3 | | -This readme might need some attention. |
|
0 commit comments