You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
#### IMPORTANT: _Scully requires the router to be present in your application, don't forget to add it._
59
59
60
-
#### IMPORTANT: _Scully requires the distrubution files to be in a subfolder of `./dist`_
60
+
#### IMPORTANT: _Scully requires the distribution files to be in a subfolder of `./dist`_
61
61
62
-
If you have an angular app, that outputs the distribution files directly into to root of `./dist` Scully can't copy all of the dist files. This is an OS file-system issue. We can't copy recursively into a subfolder of dist. The solution is set the option `architect->build->options->outputPath` to a subfolder.
62
+
If you have an angular app, that outputs the distribution files directly into the root of `./dist` Scully can't copy all of the dist files. This is an OS file-system issue. We can't copy recursively into a subfolder of dist. The solution is to set the option `architect->build->options->outputPath` to a subfolder.
63
63
64
64
## ng g @scullyio/init:blog
65
65
@@ -69,17 +69,17 @@ Once it's generated you can open the default `app.component.html` created by ang
69
69
70
70
### Home page
71
71
72
-
Since the default template from angular-cli doesn't ship an entry point for route, it might be confusing to get scully working on the very first shot
72
+
Since the default template from angular-cli doesn't ship an entry point for route, it might be confusing to get Scully working on the very first shot.
73
73
74
74
```ts
75
75
nggmhome--route=home--module=app-routing
76
76
```
77
77
78
-
This command will generate the new home page module plus a new component with a route configured
78
+
This command will generate the new home page module plus a new component with a route configured.
79
79
80
80
### Configure home as root
81
81
82
-
Open `app-routing.module.ts` and let the path attribute empty for the home route
82
+
Open `app-routing.module.ts` and let the path attribute empty for the home route.
83
83
84
84
```ts
85
85
const routes:Routes= [
@@ -93,7 +93,7 @@ const routes: Routes = [
93
93
94
94
### Inject route service
95
95
96
-
Scully provides a service to easy get access on generated routes. To list these in your template open `home.component.ts` by adding the following code
96
+
Scully provides a service to easy get access on generated routes. To list these in your template open `home.component.ts` by adding the following code:
Copy file name to clipboardExpand all lines: docs/scully-cmd-line.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,7 +23,7 @@ Scully CLI has the following options available:
23
23
npx scully serve
24
24
```
25
25
26
-
this starts the scully server helper on its own. You can use this to inspect the result from Scully, or to speed up the scully proccess a bit. it does not _build_ the project, it only serves the angular build files, and the scully result files.
26
+
This starts the scully server helper on its own. You can use this to inspect the result from Scully, or to speed up the scully proccess a bit. it does not _build_ the project, it only serves the angular build files, and the scully result files.
`ScullyConfig` interface provide the parameters to configure how scully works in your project.
49
+
`ScullyConfig` interface provide the parameters to configure how Scully works in your project.
50
50
51
51
## scullyConfig properties explained
52
52
53
53
### projectRoot
54
54
55
-
`projectRoot` is reference to the path to the project where scully will intervene.
55
+
`projectRoot` is reference to the path to the project where Scully will intervene.
56
56
57
-
This property is **_mandatory_**, scully fill automatically post installation,
57
+
This property is **_mandatory_**, Scully fills automatically post installation,
58
58
59
59
**_IMPORTANT_** this property won't be **_mandatory_** anymore in future releases.
60
60
@@ -65,7 +65,7 @@ This property is for internal use mostly, it defaults to the location where angu
65
65
66
66
### outDir
67
67
68
-
`outDir` is reference to the path folder which scully will take to put the statics files.
68
+
`outDir` is reference to the path folder which Scully will take to put the statics files.
69
69
By default the path is:
70
70
71
71
```
@@ -74,7 +74,7 @@ By default the path is:
74
74
75
75
### distFolder
76
76
77
-
`distFolder` option provide to scully the path to the compiled Angular application. By default scully take the path
77
+
`distFolder` option provide to Scully the path to the compiled Angular application. By default Scully take the path
78
78
reading the `angular.json`. You can set it up follow your needs.
79
79
80
80
### routes
@@ -102,9 +102,9 @@ handled routes reference to routes with dynamic data.
102
102
103
103
## proxyConfig
104
104
105
-
Takes a relative filename filename for a proxy config file. for details look at [this](https://github.com/chimurai/http-proxy-middleware/blob/master/README.md). We use the same config format as [webpackDevServer](https://webpack.js.org/configuration/dev-server/#devserverproxy)
105
+
Takes a relative filename filename for a proxy config file. For details look at [this](https://github.com/chimurai/http-proxy-middleware/blob/master/README.md). We use the same config format as [webpackDevServer](https://webpack.js.org/configuration/dev-server/#devserverproxy).
106
106
107
-
`routes` is a reference to all unhandled routes which scully will transform to handled, using plugins.
107
+
`routes` is a reference to all unhandled routes which Scully will transform to handled, using plugins.
108
108
If you want to know more about plugins go to [Plugins](plugins.md) section.
109
109
110
110
### extraRoutes
@@ -120,14 +120,14 @@ extraRoutes: ['/foo/id', new Promise('/bar/barId'), new Promise(['/foo/fooId', '
120
120
121
121
### appPort
122
122
123
-
Scully provide you a server to check how your Angular app works.
123
+
Scully provides you a server to check how your Angular app works.
124
124
`appPort` is the property to configure the port which your Angular app will run.
125
125
126
126
The port by default is: `1864`
127
127
128
128
### staticport
129
129
130
-
Similarly as _appPort_, the property `staticport`allow the developer set up a port to execute a server,
130
+
Similarly as _appPort_, the property `staticport`allows the developer to set up a port to execute a server,
use a different name as `localhost` for the local server. Needed if doe to environmental restrictions localhost isn't usable
148
+
Use a different name as `localhost` for the local server. Needed if doe to environmental restrictions localhost isn't usable
149
149
150
150
### hostUrl
151
151
152
-
Connect to a other server. If your app has special demands to host it, you might need to use your own server. When that is needed you can provide this setting to let scully know where to look for your running app. Make sure the server is up and running, and hosting the correct application.
152
+
Connect to another server. If your app has special demands to host it, you might need to use your own server. When that is needed you can provide this setting to let Scully knows where to look for your running app. Make sure the server is up and running, and hosting the correct application.
0 commit comments