inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-31 17:38:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Denys Vuika
2016-04-22 19:53:59 +01:00
parent 408fa8ee32
commit 2b39e91ee7
1 changed files with 37 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
demo-shell-ng2/README.md
View File

@@ -15,44 +15,55 @@
- [Alfresco Docker image with CORS support](https://github.com/wabson/alfresco-docker-cors) - [Alfresco Docker image with CORS support](https://github.com/wabson/alfresco-docker-cors)
## Start development ### Configuring development environment
Install the npm packages described in the `package.json` and verify that it works: *All scripts assume you are at the project root folder*
```bash **Install symlinks for Alfresco components**
$ npm install
$ npm run build.dev *ng2-alfresco-documentlist component:*
```sh
cd ng2-components/ng2-alfresco-documentlist
npm link
cd ../../demo-shell-ng
npm link ng2-alfresco-documentlist
``` ```
You're ready to write your application.
Remember the npm scripts in `package.json`: *ng2-alfresco-login component:*
## Development ```sh
cd ng2-components/ng2-alfresco-login
npm link
cd ../../demo-shell-ng
npm link ng2-alfresco-login
```
* To runs the compiler and a server at the same time, both in "watch mode" Please refer to [this article](https://docs.npmjs.com/cli/link) for more details on npm link.
```$ npm start``` ### Building and running
* To runs the test **Install dependencies:**
```$ npm test``` ```sh
cd dev-platform-webcomponents/demo-shell-ng2/
npm install
```
* To runs the TypeScript compiler once **(Option 1) Fast build and watch for dev purposes:**
```$ npm run tsc``` ```sh
npm start
```
* To runs the TypeScript compiler in watch mode; the process keeps running, awaiting changes to TypeScript files and re-compiling when it sees them **(Option 2) Build and watch with Gulp:**
```$ npm run tsc:w``` ```sh
npm run build.dev
```
* 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. *or*
```$ npm run lite``` ```sh
gulp dev
* 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```