Skip to content

Commit f98b4b2

Browse files
Villanuevandaaronfrost
authored andcommitted
Documentation alpha 01 (#12)
refactor(docs): Add file base add core team and getting started items to README.md add new docs files pre requisites remove old docs files getting started progress working with plugins progress add 80% of getting started remove old folder Add a more comprehensive explanation on the home Readme.… (#13) Add a more comprehensive explanation on the home Readme.md. And to more directly send people to either the getting started OR to the full documentation.
1 parent e0bc785 commit f98b4b2

14 files changed

Lines changed: 227 additions & 259 deletions

Documentation/demosteps.md

Lines changed: 0 additions & 151 deletions
This file was deleted.

Documentation/genration steps.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

Documentation/gettingStarted.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

Documentation/pupeteer_vs_universal.md

Lines changed: 0 additions & 5 deletions
This file was deleted.

Documentation/schematics.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

README.md

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,49 @@
22

33
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
44

5+
The best way to build the fastest Angular apps. Scully is a static site generator for Angular projects looking to embrace the JAMStack.
56

6-
A static site generator for Angular-CLI projects.
7+
- [Getting Started](docs/getting-started.md)
8+
- [Full Documentation](docs/scully.md)
79

8-
This is the initial setup.
10+
# What is Scully?
11+
Scully pre-renders each page in your app to plain HTML & CSS. To do this, Scully uses machine learning techniques to find
12+
all of the routes in your project. Scully then visits each route, rendering the view and saving it to an HTML file.
913

14+
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
15+
a few KBs, as opposed to the hundreds/thousands of KBs require to download your entire Angular app.
1016

17+
Your app appears INSTANTLY on any device (including mobile 3G).
1118

19+
Once the fully-rendered HTML arrives/appears on the user's view, your Angular app will them load and bootstrap ontop of
20+
the existing view. This means that Scully gives you the best of both worlds:
1221

13-
#### created by
14-
![logo](assets/logo-400x400.jpg)
22+
1. The ability to pre-render your entire app to the most base form of HTML & CSS.
23+
2. The ability to still have a full powered SPA written in Angular.
1524

25+
When your app is pre-rendered, users no longer wait until all the JavaScript has downloaded, parsed and executed before
26+
they can see and interact with your website. They can immediately begin to see and interact with the page. When your page
27+
is IMMEDIATELY available, you will have less abandoned sessions and a much higher conversion rate on our website.
1628

29+
This also means that may not need to ship your backend to production. Because the view is pre-rendered and the
30+
data is fetched at build time, all views that can run without the backend in prod CAN run without the backend in prod.
31+
The security an cost implications to that fact can be mind blowing when you think about them.
1732

33+
For those wanting to know more about this process, please read the [Getting Started](docs/getting-started.md) guide. For
34+
those who want to know more about the theory behind pre-rendering JavaScript SPAs, our friends at [Netlify](https://netlify.com)
35+
wrote a [free book about the JAMStack](https://www.netlify.com/pdf/oreilly-modern-web-development-on-the-jamstack.pdf).
36+
Check that out today.
1837

19-
## bazel things
38+
## Core Team
39+
40+
| Aaron Frost | Sander Elias | Jorge Cano | Andres Villanueva |
41+
| ------------------------------------------------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------------------|
42+
| ![Aaron Frost](https://avatars0.githubusercontent.com/u/662832?s=120&v=4&1) | ![Sander Elias](https://avatars3.githubusercontent.com/u/1249083?s=120&v=4) | ![Jorge Cano](https://avatars3.githubusercontent.com/u/5982204?s=120&v=4) | ![Andres Villanueva](https://avatars0.githubusercontent.com/u/1209238?s=120&v=4) |
43+
| [aaronfrost](https://github.com/aaronfrost) | [SanderElias](https://github.com/SanderElias) | [jorgeucano](https://github.com/jorgeucano) | [villanuevand](https://github.com/villanuevand) |
44+
45+
46+
#### Created by
47+
![logo Hero Devs](assets/hero-devs-logo-80x80.jpg)
48+
49+
***HeroDevs. LLC***
2050

21-
All with ibazel is watch mode, the same without the i is no-watch

assets/hero-devs-logo-80x80.jpg

5.84 KB
Loading

0 commit comments

Comments
 (0)