Skip to content

Commit ceb32b4

Browse files
author
TheDonDope
committed
docs(readme): update readme
- Update the environment configuration section to use the new `env-config` flag - Update the directory structure section to reflect the latest file structure
1 parent 2228464 commit ceb32b4

File tree

1 file changed

+98
-76
lines changed

1 file changed

+98
-76
lines changed

README.md

Lines changed: 98 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Provides fast, reliable and extensible starter for the development of Angular pr
2424
- Following the [best practices](https://angular.io/styleguide).
2525
- Manager of your type definitions using @types.
2626
- Has autoprefixer and css-lint support.
27+
- Provides full Docker support for both development and production environment
2728

2829
# How to start
2930

@@ -109,7 +110,7 @@ If you have different environments and you need to configure them to use differe
109110
The environment can be specified by using:
110111

111112
```bash
112-
$ npm start -- --config-env ENV_NAME
113+
$ npm start -- --env-config ENV_NAME
113114
```
114115

115116
Currently the `ENV_NAME`s are `dev`, `prod`, `staging`, but you can simply add a different file `"ENV_NAME.ts".` file in order to alter extra such environments.
@@ -208,16 +209,23 @@ Forks of this project demonstrate how to extend and integrate with other librari
208209

209210
```
210211
.
212+
├── .docker
213+
│   ├── dist-build.development.dockerfile <- Dockerfile for development environment
214+
│   └── dist-build.production.dockerfile <- Dockerfile for production environment
215+
├── .dockerignore <- ignore file for the docker builds
211216
├── LICENSE
212217
├── README.md
218+
├── appveyor.yml
219+
├── docker-compose.production.yml <- docker-compose file for production environment
220+
├── docker-compose.yml. <- docker-compose file for development environment
213221
├── gulpfile.ts <- configuration of the gulp tasks
214222
├── karma.conf.js <- configuration of the test runner
215223
├── package.json <- dependencies of the project
216224
├── protractor.conf.js <- e2e tests configuration
217225
├── src <- source code of the application
218226
│   └── client
219227
│   ├── app
220-
│   │   ├── +about
228+
│   │   ├── about
221229
│   │   │   ├── about.component.css
222230
│   │   │   ├── about.component.e2e-spec.ts
223231
│   │   │   ├── about.component.html
@@ -226,7 +234,13 @@ Forks of this project demonstrate how to extend and integrate with other librari
226234
│   │   │   ├── about.module.ts
227235
│   │   │   ├── about.routes.ts
228236
│   │   │   └── index.ts
229-
│   │   ├── +home
237+
│   │   ├── app.component.e2e-spec.ts
238+
│   │   ├── app.component.html
239+
│   │   ├── app.component.spec.ts
240+
│   │   ├── app.component.ts
241+
│   │   ├── app.module.ts
242+
│   │   ├── app.routes.ts
243+
│   │   ├── home
230244
│   │   │   ├── home.component.css
231245
│   │   │   ├── home.component.e2e-spec.ts
232246
│   │   │   ├── home.component.html
@@ -235,49 +249,45 @@ Forks of this project demonstrate how to extend and integrate with other librari
235249
│   │   │   ├── home.module.ts
236250
│   │   │   ├── home.routes.ts
237251
│   │   │   └── index.ts
238-
│   │   ├── app.component.e2e-spec.ts
239-
│   │   ├── app.component.html
240-
│   │   ├── app.component.spec.ts
241-
│   │   ├── app.component.ts
242-
│   │   ├── app.module.ts
243-
│   │   ├── app.routes.ts
244-
│   │   ├── hot_loader_main.ts
252+
│   │   ├── i18n.providers.ts
253+
│   │   ├── main-prod.ts
245254
│   │   ├── main.ts
246-
│   │   └── shared
247-
│   │   ├── config
248-
│   │   │   └── env.config.ts
249-
│   │   ├── index.ts
250-
│   │   ├── shared.module.ts
251-
│   │   ├── name-list
252-
│   │   │   ├── index.ts
253-
│   │   │   ├── name-list.service.spec.ts
254-
│   │   │   └── name-list.service.ts
255-
│   │   ├── navbar
256-
│   │   │   ├── index.ts
257-
│   │   │   ├── navbar.component.css
258-
│   │   │   ├── navbar.component.html
259-
│   │   │   └── navbar.component.ts
260-
│   │   └── toolbar
261-
│   │   ├── index.ts
262-
│   │   ├── toolbar.component.css
263-
│   │   ├── toolbar.component.html
264-
│   │   └── toolbar.component.ts
255+
│   │   ├── operators.ts
256+
│   │   ├── shared
257+
│   │   │   ├── config
258+
│   │   │   │   └── env.config.ts
259+
│   │   │   ├── index.ts
260+
│   │   │   ├── name-list
261+
│   │   │   │   ├── index.ts
262+
│   │   │   │   ├── name-list.service.spec.ts
263+
│   │   │   │   └── name-list.service.ts
264+
│   │   │   ├── navbar
265+
│   │   │   │   ├── index.ts
266+
│   │   │   │   ├── navbar.component.css
267+
│   │   │   │   ├── navbar.component.html
268+
│   │   │   │   └── navbar.component.ts
269+
│   │   │   ├── shared.module.ts
270+
│   │   │   └── toolbar
271+
│   │   │   ├── index.ts
272+
│   │   │   ├── toolbar.component.css
273+
│   │   │   ├── toolbar.component.html
274+
│   │   │   └── toolbar.component.ts
275+
│   │   └── system-config.ts
265276
│   ├── assets
266277
│   │   ├── data.json
267278
│   │   └── svg
268279
│   │   └── more.svg
269280
│   ├── css
270281
│   │   └── main.css
271282
│   ├── index.html
272-
│   ├── testing
273-
│   │   └── router
274-
│   │   ├── mock-location-strategy.ts
275-
│   │   └── router-testing-providers.ts
276283
│   └── tsconfig.json
277-
├── test-main.js <- testing configuration
284+
├── test-config.js <- testing configuration
285+
├── test-main.js <- karma test launcher
278286
├── tools
279287
│   ├── README.md <- build documentation
280288
│   ├── config
289+
│   │   ├── banner-256.txt
290+
│   │   ├── banner.txt
281291
│   │   ├── project.config.ts <- configuration of the specific project
282292
│   │   ├── seed.config.interfaces.ts
283293
│   │   └── seed.config.ts <- generic configuration of the seed project
@@ -287,72 +297,84 @@ Forks of this project demonstrate how to extend and integrate with other librari
287297
│   ├── env <- environment configuration
288298
│   │   ├── base.ts
289299
│   │   ├── dev.ts
300+
│   │   ├── env-config.interface.ts
290301
│   │   └── prod.ts
291302
│   ├── manual_typings
292303
│   │   ├── project <- manual ambient typings for the project
293304
│   │   │   └── sample.package.d.ts
294305
│   │   └── seed <- seed manual ambient typings
306+
│   │   ├── angular2-hot-loader.d.ts
295307
│   │   ├── autoprefixer.d.ts
296-
│   │   ├── colorguard.d.ts
297-
│   │   ├── connect-livereload.d.ts
298308
│   │   ├── cssnano.d.ts
299-
│   │   ├── doiuse.d.ts
300309
│   │   ├── express-history-api-fallback.d.ts
301310
│   │   ├── istream.d.ts
302311
│   │   ├── karma.d.ts
303312
│   │   ├── merge-stream.d.ts
304313
│   │   ├── open.d.ts
305-
│   │   ├── postcss-reporter.d.ts
314+
│   │   ├── operators.d.ts
306315
│   │   ├── slash.d.ts
307-
│   │   ├── stylelint.d.ts
308316
│   │   ├── systemjs-builder.d.ts
309-
│   │   ├── tildify.d.ts
310-
│   │   ├── tiny-lr.d.ts
311-
│   │   └── walk.d.ts
317+
│   │   └── tildify.d.ts
312318
│   ├── tasks <- gulp tasks
319+
│   │   ├── assets_task.ts
320+
│   │   ├── css_task.ts
313321
│   │   ├── project <- project specific gulp tasks
314322
│   │   │   └── sample.task.ts
315323
│   │   └── seed <- seed generic gulp tasks. They can be overriden by the project specific gulp tasks
316-
│   │   ├── build.assets.dev.ts
317-
│   │   ├── build.assets.prod.ts
318-
│   │   ├── build.bundles.app.ts
319-
│   │   ├── build.bundles.ts
320-
│   │   ├── build.docs.ts
321-
│   │   ├── build.html_css.ts
322-
│   │   ├── build.index.dev.ts
323-
│   │   ├── build.index.prod.ts
324-
│   │   ├── build.js.dev.ts
325-
│   │   ├── build.js.e2e.ts
326-
│   │   ├── build.js.prod.ts
327-
│   │   ├── build.js.test.ts
328-
│   │   ├── build.js.tools.ts
329-
│   │   ├── check.versions.ts
330-
│   │   ├── clean.all.ts
331-
│   │   ├── clean.coverage.ts
332-
│   │   ├── clean.dev.ts
333-
│   │   ├── clean.prod.ts
334-
│   │   ├── clean.tools.ts
335-
│   │   ├── copy.js.prod.ts
336-
│   │   ├── css-lint.ts
337-
│   │   ├── e2e.ts
338-
│   │   ├── generate.manifest.ts
339-
│   │   ├── karma.start.ts
340-
│   │   ├── serve.coverage.ts
341-
│   │   ├── serve.docs.ts
342-
│   │   ├── server.prod.ts
343-
│   │   ├── server.start.ts
344-
│   │   ├── tslint.ts
345-
│   │   ├── watch.dev.ts
346-
│   │   ├── watch.e2e.ts
347-
│   │   ├── watch.test.ts
348-
│   │   └── webdriver.ts
324+
│   │   │   ├── build.assets.dev.ts
325+
│   │   │   ├── build.assets.prod.ts
326+
│   │   │   ├── build.bundle.rxjs.ts
327+
│   │   │   ├── build.bundles.app.exp.ts
328+
│   │   │   ├── build.bundles.app.ts
329+
│   │   │   ├── build.bundles.ts
330+
│   │   │   ├── build.docs.ts
331+
│   │   │   ├── build.html_css.ts
332+
│   │   │   ├── build.index.dev.ts
333+
│   │   │   ├── build.index.prod.ts
334+
│   │   │   ├── build.js.dev.ts
335+
│   │   │   ├── build.js.e2e.ts
336+
│   │   │   ├── build.js.prod.exp.ts
337+
│   │   │   ├── build.js.prod.ts
338+
│   │   │   ├── build.js.test.ts
339+
│   │   │   ├── build.tools.ts
340+
│   │   │   ├── check.tools.ts
341+
│   │   │   ├── check.versions.ts
342+
│   │   │   ├── clean.all.ts
343+
│   │   │   ├── clean.coverage.ts
344+
│   │   │   ├── clean.dev.ts
345+
│   │   │   ├── clean.prod.ts
346+
│   │   │   ├── clean.tools.ts
347+
│   │   │   ├── clear.files.ts
348+
│   │   │   ├── compile.ahead.prod.ts
349+
│   │   │   ├── copy.prod.ts
350+
│   │   │   ├── e2e.ts
351+
│   │   │   ├── generate.manifest.ts
352+
│   │   │   ├── karma.run.ts
353+
│   │   │   ├── karma.run.with_coverage.ts
354+
│   │   │   ├── karma.watch.ts
355+
│   │   │   ├── minify.bundles.ts
356+
│   │   │   ├── print.banner.ts
357+
│   │   │   ├── serve.coverage.ts
358+
│   │   │   ├── serve.coverage.watch.ts
359+
│   │   │   ├── serve.docs.ts
360+
│   │   │   ├── server.prod.ts
361+
│   │   │   ├── server.start.ts
362+
│   │   │   ├── start.deving.ts
363+
│   │   │   ├── tslint.ts
364+
│   │   │   ├── watch.dev.ts
365+
│   │   │   ├── watch.e2e.ts
366+
│   │   │   ├── watch.test.ts
367+
│   │   │   └── webdriver.ts
368+
│   │   ├── task.ts
369+
│   │   └── typescript_task.ts
349370
│   ├── utils <- build utils
350371
│   │   ├── project <- project specific gulp utils
351372
│   │   │   └── sample_util.ts
352373
│   │   ├── project.utils.ts
353374
│   │   ├── seed <- seed specific gulp utils
354375
│   │   │   ├── clean.ts
355376
│   │   │   ├── code_change_tools.ts
377+
│   │   │   ├── karma.start.ts
356378
│   │   │   ├── server.ts
357379
│   │   │   ├── tasks_tools.ts
358380
│   │   │   ├── template_locals.ts
@@ -362,7 +384,7 @@ Forks of this project demonstrate how to extend and integrate with other librari
362384
│   └── utils.ts
363385
├── tsconfig.json <- configuration of the typescript project (ts-node, which runs the tasks defined in gulpfile.ts)
364386
├── tslint.json <- tslint configuration
365-
└── appveyor.yml
387+
└── yarn.lock
366388
```
367389

368390
# Contributors

0 commit comments

Comments
 (0)