Skip to content

Commit f78646e

Browse files
IxquitilisSaidVillanuevand
authored andcommitted
docs(scully): small improvements to the getting-started.
1 parent 1e558e0 commit f78646e

File tree

1 file changed

+25
-28
lines changed

1 file changed

+25
-28
lines changed

docs/getting-started.md

Lines changed: 25 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22

33
The first thing you need to get started with Scully is a working Angular app using **Angular 9.x.x**
44

5-
This getting started doc covers the three steps to adding Scully into your project.
5+
This getting started doc covers the three steps to adding Scully into your project.
66

77
1. [Installation](#installation)
88
2. [Build](#build)
9-
3. [Test](#test)
9+
3. [Test](#test)
1010

1111

1212
## Installation
13-
To install Scully, do the following: From the root directory of your Angular project (in a terminal window), run the following command:
13+
To install Scully, execute the following command from the root directory of your Angular project (in a terminal window):
1414
```bash
1515
ng add @scullyio/init
1616
```
1717

18-
The command above set up the necessary to start to work with Scully (_we go to get more deep about this in next releases._).
18+
The command above installs dependencies and configures the files needed to start building with Scully (_we will further elaborate on this in upcoming releases_).
1919

20-
If the installation was success you can read a message similar to this one.
20+
If the installation was successful a message similar to this one will be displayed:
2121

2222
```bash
2323
Installed packages for tooling via yarn.
@@ -33,50 +33,47 @@ CREATE scully.config.js (65 bytes)
3333
UPDATE package.json (1507 bytes)
3434
```
3535

36-
#### IMPORTANT
37-
*Scully needs the router be present in your application, do not forget add it.*
36+
#### IMPORTANT: *Scully requires the router to be present in your application, don't forget to add it.*
3837

3938
## @scullyio/init:blog
4039

4140
## Build
4241

43-
So you have your Angular app AND you have installed Scully. So let's run a scully build to turn your site into a
44-
pre-rendered Angular app. Because scully runs based on a build of your app, the first step is to build your Angular
45-
project. Then you can run the scully build.
42+
By now you should have your Angular project with Scully successfully installed, so let us run a Scully build and turn your site into a
43+
pre-rendered Angular app.
44+
45+
Since Scully runs based on a build of your app, the first step is to build your Angular project, subsequently running the Scully build.
4646

4747
```bash
4848
ng build
4949
npm run scully
5050
```
5151

52-
That's it. You're done! In your project directory, you now have a `/dist/static` folder that contains the built version
53-
of your app.
52+
That's it, you're done! In your project directory, you should now have a `/dist/static` folder containing the built version
53+
of your app.
5454

55-
__NOTE:__ If you had any errors or warning during the build phase, please follow the instructions in the errors/warnings
56-
(if applicable) or [submit an issue](https://github.com/scullyio/scully/issues/new/choose).
55+
__NOTE:__ If you had any errors or warnings during the build phase, please follow the instructions in the errors/warnings
56+
(if applicable) or [submit an issue](https://github.com/scullyio/scully/issues/new/choose).
5757

5858
## Test
5959

60-
Now that you're project has been pre-rendered, you can validate the build in one of a few ways.
61-
62-
1. Serve the contents of your `dist/static` directory
63-
2. Browse the contents of `dist/static` directory and read the HTML
60+
Now that your project has been pre-rendered, you can validate the build by either:
6461

65-
#### Serve the contents
62+
#### Serving the contents
6663

67-
Using something like [http-server](https://www.npmjs.com/package/http-server) you can serve the contents of your
68-
`dist/static` folder. All routes that work in your non-pre-rendered Angular app should still work. Not all apps are
69-
capable of running without
64+
By utilizing something like [http-server](https://www.npmjs.com/package/http-server) you can serve the contents of your
65+
`dist/static` folder. All of the routes in your non-pre-rendered Angular app should still work. Not all apps are
66+
capable of running without
7067

71-
__Extra Credit__: While serving your app, [disable JavaScript](https://developers.google.com/web/tools/chrome-devtools/javascript/disable)
72-
and make sure that you app still works. This is the goal for your app, to run with JavaScript disabled. Most of the
73-
parts of your app should work without JS enabled.
68+
[//]: # (Missing text for the line above)
7469

75-
#### Browse the contents
70+
__Extra Credit__: While serving your app, [disable JavaScript](https://developers.google.com/web/tools/chrome-devtools/javascript/disable)
71+
and make sure that it still works. This is the goal for your app, to run with JavaScript disabled. Most parts of your app should still work without JS enabled.
7672

77-
Browse the contents of your `dist/static` directory and make sure that all of your pages were pre-rendered and saved to
78-
HTML correctly.
73+
#### Browsing the contents
7974

75+
Browse the contents of your `dist/static` directory and make sure that all of your pages were pre-rendered and saved to
76+
HTML correctly.
8077

8178
---
8279
[Full Documentation ➡️](scully.md)

0 commit comments

Comments
 (0)