mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-19 17:14:57 +00:00
101 lines
2.7 KiB
Markdown
101 lines
2.7 KiB
Markdown
|
|
<h1 align="center">Alfresco Angular 2 Components</h1>
|
|
<p align="center">
|
|
<img title="alfresco" alt='alfresco' src='../assets/alfresco.png' width="280px" 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>
|
|
|
|
## Installing
|
|
|
|
To correctly use this demo check that on your machine is running [Node](https://nodejs.org/en/) version 5.x.x or higher.
|
|
|
|
```sh
|
|
git clone https://github.com/Alfresco/alfresco-ng2-components.git
|
|
cd alfresco-ng2-components/demo-shell-ng2/
|
|
npm install
|
|
```
|
|
|
|
## Development build
|
|
|
|
```sh
|
|
npm start
|
|
```
|
|
|
|
This command compiles and starts the project in watch mode.
|
|
Browser will automatically reload upon changes.
|
|
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
|
|
|
|
```sh
|
|
npm run build
|
|
npm run start:dist
|
|
```
|
|
|
|
This command builds project in `production` mode.
|
|
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.
|
|
|
|
### Important notes
|
|
|
|
By default demo application is configured to use [wsrv](https://www.npmjs.com/package/wsrv) tool (lightweight web server)
|
|
to serve production build output. It will be running at `0.0.0.0` address with port `3000` and allow you accessing your application
|
|
via network. However you can use any web server of your choice in production.
|
|
|
|
## Development branch build
|
|
|
|
If you want to run the demo shell with the latest change from the development branch, use the following command from the /script folder:
|
|
|
|
```sh
|
|
./npm-clean.sh
|
|
./start-linked.sh -install
|
|
```
|
|
|
|
## Multi-language
|
|
To support a new language you need to create your language file (.json) and add it to `i18n/` folder.
|
|
|
|
```json
|
|
{
|
|
"username" : "Username",
|
|
"input-required-message": "Required",
|
|
"input-min-message": "Your username needs to be at least 4 characters.",
|
|
"login-button": "Login"
|
|
}
|
|
```
|
|
|
|
Directory structure:
|
|
```
|
|
.
|
|
├── i18n/
|
|
│ ├── en.json
|
|
│ ├── it.json
|
|
│ └── fr.json
|
|
```
|
|
|
|
## Custom-files
|
|
|
|
If you need to add custom files on your project you can add this files in the folders public
|
|
|
|
```
|
|
.
|
|
├── public/
|
|
│ ├── images/
|
|
│ ├── css/
|
|
│ └── js/
|
|
```
|
|
|
|
the public folder above wil be copied in the root of your project and you can refer to them for example as
|
|
|
|
* './images/custom_image.png'
|
|
* './js/custom_script.js'
|
|
* './css/custom_style.css'
|