inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-05-26 17:24:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

readme updates

Browse Source
This commit is contained in:
Denys Vuika 2017-01-11 13:15:26 +00:00
parent 9fb085eb3a
commit 6f24ebd6d4
3 changed files with 20 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -56,6 +56,12 @@ To view the complete list of all the components that you can use to build your c
You can browse all the components at the following [page](http://devproducts.alfresco.com/). You can browse all the components at the following [page](http://devproducts.alfresco.com/).
## Demo Application
A separate application showcasing integration of components can be found [here](https://github.com/Alfresco/alfresco-ng2-components/tree/master/demo-shell-ng2).
You will find examples of basic interaction for both BPM and ECM sets of widgets.
## Yeoman generators ## Yeoman generators
To speed up the development of your Alfresco Angular 2 application, or Alfresco Angular 2 component, use one of the Yeoman generators. To speed up the development of your Alfresco Angular 2 application, or Alfresco Angular 2 component, use one of the Yeoman generators.

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

@ -12,9 +12,11 @@
## Installing ## Installing
To correctly use this demo check that on your machine is running Node version 6.9.2 LTS or higher. To correctly use this demo check that on your machine is running [Node](https://nodejs.org/en/) version 6.9.2 LTS or higher.
```sh ```sh
git clone https://github.com/Alfresco/alfresco-ng2-components.git
cd alfresco-ng2-components/demo-shell-ng2/
npm install npm install
``` ```
@ -28,22 +30,26 @@ This command compiles and starts the project in watch mode.
Browser will automatically reload upon changes. Browser will automatically reload upon changes.
Upon start you can navigate to `http://localhost:3000` with your preferred browser. Upon start you can navigate to `http://localhost:3000` with your preferred browser.
### Important notes
This script is recommended for development environment and not suited for headless servers and network access.
## Production build ## Production build
```sh ```sh
npm run build npm run build
npm run start:dist
``` ```
This command builds broject in `production` mode. This command builds broject in `production` mode.
All output is placed to `dist` folder and can be served your preferred web server. All output is placed to `dist` folder and can be served your preferred web server.
You should need no additional files outside the `dist` folder. You should need no additional files outside the `dist` folder.
In order to quickly test the output you can use the [wsrv](https://www.npmjs.com/package/wsrv) tool (lightweight web server): ### Important notes
```sh By default demo application is configured to use [wsrv](https://www.npmjs.com/package/wsrv) tool (lightweight web server)
npm install -g wsrv to serve production build output. It will be running at `0.0.0.0` address with port `3000` and allow you accessing your application
wsrv -s -o dist/ via network. However you can use any web server of your choice in production.
```
## Development branch build ## Development branch build

2
ng2-components/ng2-alfresco-datatable/README.md
View File

@ -32,6 +32,8 @@
</a> </a>
</p> </p>
See it live: [DataTable Quickstart](https://embed.plnkr.co/80qr4YFBeHjLMdAV0F6l/)
## Prerequisites ## Prerequisites
Before you start using this development framework, make sure you have installed all required software and done all the Before you start using this development framework, make sure you have installed all required software and done all the