|
1 | 1 | # Example app with Angular 5 + Angular CLI + Angular Material + Docker + Angular Example Library |
2 | 2 |
|
3 | | -> ### Base project made with much :heart: . Contains CRUD, official style guide, patterns, custom library, etc. |
| 3 | +> ### Base project made with much :heart: . Contains CRUD, patterns, custom library, etc. |
4 | 4 |
|
5 | 5 |  |
6 | 6 | [](https://coveralls.io/github/Ismaestro/angular5-example-app?branch=master) |
|
18 | 18 | [](https://github.com/ismaestro/angular5-example-app/fork) |
19 | 19 | [](https://github.com/ismaestro/angular5-example-app) |
20 | 20 |
|
21 | | -### DEMO |
22 | | - |
23 | | -Live DEMO [here](http://angularexampleapp.com/)! |
| 21 | +## [LIVE DEMO](http://angularexampleapp.com/) |
24 | 22 |
|
25 | 23 | [](http://angularexampleapp.com/) |
26 | 24 |
|
27 | | -## Usage |
28 | | - |
29 | | -**Warning: we strongly recommend node >=v6.9.0 and npm >=3.0.0** |
30 | | - |
31 | | -`npm i` - Installs everything needed |
32 | | - |
33 | | -`npm start` - Starts the app. Then, go to `localhost:4200` |
34 | | - |
35 | | -`npm run test` - Runs unit tests with karma and jasmine |
36 | | - |
37 | | -`npm run e2e` - Runs end to end tests |
38 | | - |
39 | | -`npm run e2e:home` - Runs end to end tests only for the home directory. There are more commands like this one, for development purposes |
| 25 | +## Getting started |
40 | 26 |
|
41 | | -`npm run build` - Builds the app for production |
| 27 | +**Warning: strongly recommended node >=v6.9.0 and npm >=3.0.0** |
42 | 28 |
|
43 | | -`npm run lint` - Runs the linter (tslint) |
| 29 | +1. Go to project folder and install dependencies: |
| 30 | + ```bash |
| 31 | + npm install |
| 32 | + ``` |
| 33 | + |
| 34 | +2. Launch development server, and open `localhost:4200` in your browser: |
| 35 | + ```bash |
| 36 | + npm start |
| 37 | + ``` |
44 | 38 |
|
45 | | -`npm run ci` - Executes linter and tests |
46 | | - |
47 | | -`npm run deploy` - Builds the app and deploy it to Github pages (angular-cli-ghpages) (fork to do this and remove CNAME file) |
48 | | - |
49 | | -`npm run sme` - Builds and runs source map explorer, really cool :) |
50 | | - |
51 | | -`npm run release` - Creates a new release using standard-version |
52 | | - |
53 | | -`npm run docker` - Builds the docker image and run the container |
54 | | - |
55 | | -**Windows: use precompilation to speed up** |
| 39 | +## Usage |
56 | 40 |
|
57 | | -`tsc --project tsconfig.json` |
58 | | -`npm start` |
| 41 | +Tasks | Description |
| 42 | +--------------------|--------------------------------------------------------------------------------------- |
| 43 | +npm i | Installs everything needed |
| 44 | +npm start | Starts the app. Then, go to `localhost:4200` |
| 45 | +npm run test | Runs unit tests with karma and jasmine |
| 46 | +npm run e2e | Runs end to end tests |
| 47 | +npm run e2e:home | Runs end to end tests only for the home directory |
| 48 | +npm run build | Builds the app for production |
| 49 | +npm run lint | Runs the linter (tslint) |
| 50 | +npm run ci | Executes linter and tests |
| 51 | +npm run deploy | Builds the app and deploy it to Github pages (angular-cli-ghpages) (fork to do this and remove CNAME file) |
| 52 | +npm run sme | Builds and runs source map explorer, really cool :) |
| 53 | +npm run release | Creates a new release using standard-version |
| 54 | +npm run docker | Builds the docker image and run the container |
59 | 55 |
|
60 | 56 | ## Features |
| 57 | + |
61 | 58 | * Responsive layout (flex layout module) |
62 | 59 | * Internationalization |
63 | 60 | * Lazy loading modules |
64 | 61 | * Interceptors and Events (Progress bar active, if a request is pending) |
65 | 62 | * CRUD: create, update and remove heroes |
66 | | -* Service Workers! |
| 63 | +* Service Workers |
67 | 64 | * Custom example library |
68 | 65 | * Search bar, to look for heroes |
69 | 66 | * Angular Pipes |
|
0 commit comments