makeup readme

This commit is contained in:
Eugenio Romano
2016-04-19 16:27:21 +01:00
parent 14a434d684
commit 84e5a6a45b
4 changed files with 41 additions and 11 deletions

View File

@@ -1,3 +1,16 @@
<h1 align="center">Alfresco Angular 2 Components</h1>
<p align="center">
<img title="alfresco" alt='alfresco' src='../assets/alfresco.png' width="200px" height="150px" ></img>
<img title="angular2" alt='angular2' src='../assets/angular2.png' width="150px" height="150px" ></img>
</p>
<p align="center">
<a href='https://github.com/mgechev/angular2-style-guide'>
<img src='https://mgechev.github.io/angular2-style-guide/images/badge.svg' alt='style' />
</a>
</p>
### Prerequisites
- [Alfresco Docker image with CORS support](https://github.com/wabson/alfresco-docker-cors)
@@ -14,12 +27,28 @@ You're ready to write your application.
Remember the npm scripts in `package.json`:
* `npm start` - runs the compiler and a server at the same time, both in "watch mode".
* `npm run tsc` - runs the TypeScript compiler once.
* `npm run tsc:w` - runs the TypeScript compiler in watch mode; the process keeps running, awaiting changes to TypeScript files and re-compiling when it sees them.
* `npm run lite` - runs the [lite-server](https://www.npmjs.com/package/lite-server), a light-weight, static file server, written and maintained by
[John Papa](https://github.com/johnpapa) and
[Christopher Martin](https://github.com/cgmartin)
with excellent support for Angular apps that use routing.
* `npm run typings` - runs the typings tool.
* `npm run postinstall` - called by *npm* automatically *after* it successfully completes package installation. This script installs the TypeScript definition files this app requires.
## Development
* To runs the compiler and a server at the same time, both in "watch mode"
```$ npm start```
* To runs the TypeScript compiler once
```$ npm run tsc``
* To runs the TypeScript compiler in watch mode; the process keeps running, awaiting changes to TypeScript files and re-compiling when it sees them
```$ npm run tsc:w``
* To runs the [lite-server](https://www.npmjs.com/package/lite-server), a light-weight, static file server, written and maintained by [John Papa](https://github.com/johnpapa) and [Christopher Martin](https://github.com/cgmartin) with excellent support for Angular apps that use routing.
```$ npm run lite``
* To runs the typings tool
```$ npm run typings``
* called by *npm* automatically *after* it successfully completes package installation. This script installs the TypeScript definition files this app requires
```$ npm run postinstall``

View File

@@ -28,15 +28,16 @@
"zone.js": "0.6.10"
},
"devDependencies": {
"concurrently": "^2.0.0",
"browser-sync": "^2.10.0",
"concurrently": "^2.0.0",
"del": "^2.1.0",
"gulp": "^3.9.1",
"gulp-sourcemaps": "^1.6.0",
"gulp-tslint": "^3.6.0",
"gulp-typescript": "^2.8.0",
"tsconfig-glob": "^0.3.3",
"jasmine-core": "2.4.1",
"lite-server": "^2.2.0",
"tsconfig-glob": "^0.3.3",
"typescript": "^1.8.10",
"typings": "^0.7.12"
}