Skip to content

Commit 0964369

Browse files
IsmaestroIsmael Ramos
authored andcommitted
feat(readme): updated readme file
1 parent 30f0c5e commit 0964369

File tree

1 file changed

+30
-33
lines changed

1 file changed

+30
-33
lines changed

README.md

Lines changed: 30 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Example app with Angular 5 + Angular CLI + Angular Material + Docker + Angular Example Library
22

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.
44
55
![travis](https://travis-ci.org/Ismaestro/angular5-example-app.svg?branch=master)
66
[![Coverage Status](https://coveralls.io/repos/github/Ismaestro/angular5-example-app/badge.svg?branch=master)](https://coveralls.io/github/Ismaestro/angular5-example-app?branch=master)
@@ -18,52 +18,49 @@
1818
[![GitHub forks](https://img.shields.io/github/forks/ismaestro/angular5-example-app.svg?style=social&label=Fork)](https://github.com/ismaestro/angular5-example-app/fork)
1919
[![GitHub stars](https://img.shields.io/github/stars/ismaestro/angular5-example-app.svg?style=social&label=Star)](https://github.com/ismaestro/angular5-example-app)
2020

21-
### DEMO
22-
23-
Live DEMO [here](http://angularexampleapp.com/)!
21+
## [LIVE DEMO](http://angularexampleapp.com/)
2422

2523
[![angular-example-app](http://thumbsnap.com/i/aIpN07i3.png?0812)](http://angularexampleapp.com/)
2624

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
4026

41-
`npm run build` - Builds the app for production
27+
**Warning: strongly recommended node >=v6.9.0 and npm >=3.0.0**
4228

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+
```
4438

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
5640

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
5955

6056
## Features
57+
6158
* Responsive layout (flex layout module)
6259
* Internationalization
6360
* Lazy loading modules
6461
* Interceptors and Events (Progress bar active, if a request is pending)
6562
* CRUD: create, update and remove heroes
66-
* Service Workers!
63+
* Service Workers
6764
* Custom example library
6865
* Search bar, to look for heroes
6966
* Angular Pipes

0 commit comments

Comments
 (0)