Skip to content

Commit

Permalink
feat(readme): updated readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
Ismaestro authored and Ismael Ramos committed Apr 16, 2018
1 parent 30f0c5e commit 0964369
Showing 1 changed file with 30 additions and 33 deletions.
63 changes: 30 additions & 33 deletions README.md
@@ -1,6 +1,6 @@
# Example app with Angular 5 + Angular CLI + Angular Material + Docker + Angular Example Library

> ### Base project made with much :heart: . Contains CRUD, official style guide, patterns, custom library, etc.
> ### Base project made with much :heart: . Contains CRUD, patterns, custom library, etc.
![travis](https://travis-ci.org/Ismaestro/angular5-example-app.svg?branch=master)
[![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)
Expand All @@ -18,52 +18,49 @@
[![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)
[![GitHub stars](https://img.shields.io/github/stars/ismaestro/angular5-example-app.svg?style=social&label=Star)](https://github.com/ismaestro/angular5-example-app)

### DEMO

Live DEMO [here](http://angularexampleapp.com/)!
## [LIVE DEMO](http://angularexampleapp.com/)

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

## Usage

**Warning: we strongly recommend node >=v6.9.0 and npm >=3.0.0**

`npm i` - Installs everything needed

`npm start` - Starts the app. Then, go to `localhost:4200`

`npm run test` - Runs unit tests with karma and jasmine

`npm run e2e` - Runs end to end tests

`npm run e2e:home` - Runs end to end tests only for the home directory. There are more commands like this one, for development purposes
## Getting started

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

`npm run lint` - Runs the linter (tslint)
1. Go to project folder and install dependencies:
```bash
npm install
```

2. Launch development server, and open `localhost:4200` in your browser:
```bash
npm start
```

`npm run ci` - Executes linter and tests

`npm run deploy` - Builds the app and deploy it to Github pages (angular-cli-ghpages) (fork to do this and remove CNAME file)

`npm run sme` - Builds and runs source map explorer, really cool :)

`npm run release` - Creates a new release using standard-version

`npm run docker` - Builds the docker image and run the container

**Windows: use precompilation to speed up**
## Usage

`tsc --project tsconfig.json`
`npm start`
Tasks | Description
--------------------|---------------------------------------------------------------------------------------
npm i | Installs everything needed
npm start | Starts the app. Then, go to `localhost:4200`
npm run test | Runs unit tests with karma and jasmine
npm run e2e | Runs end to end tests
npm run e2e:home | Runs end to end tests only for the home directory
npm run build | Builds the app for production
npm run lint | Runs the linter (tslint)
npm run ci | Executes linter and tests
npm run deploy | Builds the app and deploy it to Github pages (angular-cli-ghpages) (fork to do this and remove CNAME file)
npm run sme | Builds and runs source map explorer, really cool :)
npm run release | Creates a new release using standard-version
npm run docker | Builds the docker image and run the container

## Features

* Responsive layout (flex layout module)
* Internationalization
* Lazy loading modules
* Interceptors and Events (Progress bar active, if a request is pending)
* CRUD: create, update and remove heroes
* Service Workers!
* Service Workers
* Custom example library
* Search bar, to look for heroes
* Angular Pipes
Expand Down

0 comments on commit 0964369

Please sign in to comment.