Skip to content

Commit aa7baed

Browse files
committed
updated readme
1 parent 4b1035b commit aa7baed

File tree

1 file changed

+27
-26
lines changed

1 file changed

+27
-26
lines changed

README.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -73,25 +73,26 @@ Check yourself using this easy test procedure:
7373

7474
```
7575
.
76-
├── assets # static assets copied to dist folder
77-
├── src # app source code
78-
│ ├── components # global reusable presentational components
79-
│ ├── containers # container components providing redux context
80-
│ ├── layouts # components defining page layouts
81-
│ ├── reducers # modules containing redux reducers/constants/action creators
82-
│ ├── services # modules abstracting communication with web services
83-
│ ├── typings # custom TypeScript definitions
84-
│ ├── utils # app utility modules
85-
│ ├── app.tsx # app entry module with routing config
86-
│ ├── store.tsx # app store module
87-
│ ├── test-runner.tsx # test suites config
88-
│ └── tsconfig.tsx # TypeScript compiler config
89-
├── dev-bundle.config.js # libs should be included in dev bundle
90-
├── index.html # index.html
91-
├── jspm.config.js # system.js config for app dependencies
92-
├── jspm.init.js # system.js app import & hot-reload setup
93-
├── server.js # dev-server entry module
94-
└── tslint.json # linter config
76+
├── assets # static assets copied to dist folder
77+
├── src # app source code
78+
│ ├── components # global reusable presentational components
79+
│ ├── containers # container components providing redux context
80+
│ ├── layouts # components defining page layouts
81+
│ ├── reducers # modules containing redux reducers/constants/action creators
82+
│ ├── services # modules abstracting communication with web services
83+
│ ├── typings # custom TypeScript definitions
84+
│ ├── utils # app utility modules
85+
│ ├── app.tsx # app entry module with routing config
86+
│ ├── store.tsx # app store module
87+
│ ├── test-runner.tsx # test suites config
88+
│ └── tsconfig.tsx # TypeScript compiler config
89+
├── bundle-config.vendor.dev.js # packages included in dev vendor bundle
90+
├── bundle-config.vendor.js # packages included in prod vendor bundle
91+
├── index.html # index.html
92+
├── jspm.config.js # system.js config for app dependencies
93+
├── jspm.init.js # system.js app import & hot-reload setup
94+
├── server.js # dev-server entry module
95+
└── tslint.json # linter config
9596
```
9697

9798
---
@@ -134,10 +135,10 @@ Because of this approach it is highly scalable with increasing modules count in
134135
2. `npm start` - browser will open automatically
135136

136137
#### Build for Production Workflow
137-
1. `npm run build` - package created in 'dist' folder
138-
- `npm run build:app` - build only app.js _(run when app source code has changed)_
139-
- `npm run build:vendor` - build only vendor.js _(run when app dependencies has changed)_
140-
2. open `http://localhost/dist/` - to check build on local server
138+
1. `npm run build` - create app.js & vendor.js bundles in 'dist' folder
139+
- `npm run build:app` - build only app.js bundle _(run when app source code has changed)_
140+
- `npm run build:vendor` - build only vendor.js bundle _(run when app dependencies has changed)_
141+
2. open `http://localhost/dist/` - check prod build on local server
141142

142143
---
143144

@@ -147,9 +148,9 @@ Because of this approach it is highly scalable with increasing modules count in
147148

148149
#### Development Bundling
149150

150-
`npm run bundle-dev` - bundle static dependencies for quick full-page reload, app sources remain as seperate modules for on-the-fly HMR & transpilation
151+
`npm run bundle-dev` - build vendor packages in single file bundle for quick full-page reload __(app sources remain as seperate modules for on-the-fly HMR & transpilation)__
151152

152-
`npm run unbundle` - un-bundle static dependencies (usefull when changing app dependencies)
153+
`npm run unbundle` - delete vendor bundle package __(WARNING: it will result in loading all of vendor packages as seperate requests - use it only if you know what you are doing e.g. when experimenting with HTTP/2 multiplexing/pipelining)__
153154

154155
#### Production Bundling (`dist/` folder)
155156

@@ -159,7 +160,7 @@ Because of this approach it is highly scalable with increasing modules count in
159160

160161
`npm run build:vendor` - build app dependencies bundle (only vendor dependencies) - minified, no source-maps
161162

162-
`npm run build:debug` - build app sources bundle - debug version with source-maps
163+
`npm run build:debug` - build app sources bundle - non-minified version with source-maps
163164

164165
#### Initialization
165166

0 commit comments

Comments
 (0)