-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/dormd/ng2-countries
- Loading branch information
Showing
1 changed file
with
29 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,34 +1,43 @@ | ||
| # Ng2Countries | ||
| All about countries using angular 2. | ||
|
|
||
| The project written in [Angular 2](https://angular.io), [Typescript 2](https://www.typescriptlang.org) and use [Angular Material 2](https://material.angular.io) and [ng2-bootstrap](https://valor-software.com/ng2-bootstrap). | ||
|
|
||
| The project was generated with [angular-cli](https://github.com/angular/angular-cli). | ||
|
|
||
| ## Demo app | ||
| You can see how fun to use this npm in our [Demo Application](https://dormd.github.io/ng2-countries). | ||
|
|
||
| ## Angular-cli | ||
| This project was generated with [angular-cli](https://github.com/angular/angular-cli) version 1.0.0-beta.16. | ||
| ## Table of Contents | ||
| * [Demo app](#demo-app) | ||
| * [List of Features](#list-of-features) | ||
| * [Development server](#development-server) | ||
| * [Build](#build) | ||
| * [Deploying to Github Pages](#deploying-to-github-pages) | ||
|
|
||
| ## List of Features | ||
| * Cards view | ||
| * World flags map view | ||
| * Native language Speaker | ||
| * Countries flags | ||
| * Countries borders bar | ||
| * Shuffle | ||
| * Countries search | ||
| * Population sort | ||
| * Area size sort | ||
| * Anthems | ||
| * Countries gallery | ||
| * Countries outlines | ||
| * Coat of arms | ||
|
|
||
| ## Development server | ||
| Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. | ||
|
|
||
| ## Code scaffolding | ||
|
|
||
| Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive/pipe/service/class`. | ||
| ## Development server | ||
| Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. | ||
|
|
||
| ## Build | ||
|
|
||
| Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build. | ||
|
|
||
| ## Running unit tests | ||
|
|
||
| Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io). | ||
|
|
||
| ## Running end-to-end tests | ||
|
|
||
| Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/). | ||
| Before running the tests make sure you are serving the app via `ng serve`. | ||
|
|
||
| ## Deploying to Github Pages | ||
|
|
||
| Run `ng github-pages:deploy` to deploy to Github Pages. | ||
|
|
||
| ## Further help | ||
|
|
||
| To get more help on the `angular-cli` use `ng --help` or go check out the [Angular-CLI README](https://github.com/angular/angular-cli/blob/master/README.md). |