mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-19 17:14:57 +00:00
102 lines
2.0 KiB
Markdown
102 lines
2.0 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>
|
|
|
|
|
|
## Prerequisites
|
|
|
|
- [Alfresco Docker image with CORS support](https://github.com/wabson/alfresco-docker-cors)
|
|
|
|
### Configuring development environment
|
|
|
|
*All scripts assume you are at the project root folder*
|
|
|
|
**Install symlinks for Alfresco components**
|
|
|
|
*ng2-alfresco-core:*
|
|
|
|
```sh
|
|
cd ng2-components/ng2-alfresco-core
|
|
npm link
|
|
cd ../../demo-shell-ng
|
|
npm link ng2-alfresco-core
|
|
```
|
|
|
|
*ng2-alfresco-documentlist component:*
|
|
|
|
```sh
|
|
cd ng2-components/ng2-alfresco-documentlist
|
|
npm link
|
|
cd ../../demo-shell-ng
|
|
npm link ng2-alfresco-documentlist
|
|
```
|
|
|
|
*ng2-alfresco-login component:*
|
|
|
|
```sh
|
|
cd ng2-components/ng2-alfresco-login
|
|
npm link
|
|
cd ../../demo-shell-ng
|
|
npm link ng2-alfresco-login
|
|
```
|
|
|
|
Please refer to [this article](https://docs.npmjs.com/cli/link) for more details on npm link.
|
|
|
|
### Building and running
|
|
|
|
**Install dependencies:**
|
|
|
|
```sh
|
|
cd dev-platform-webcomponents/demo-shell-ng2/
|
|
npm install
|
|
```
|
|
|
|
**(Option 1) Fast build and watch for dev purposes:**
|
|
|
|
```sh
|
|
npm start
|
|
```
|
|
|
|
**(Option 2) Build and watch with Gulp:**
|
|
|
|
```sh
|
|
npm run build.dev
|
|
```
|
|
|
|
*or*
|
|
|
|
```sh
|
|
gulp dev
|
|
```
|
|
|
|
|
|
###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
|
|
```
|
|
|
|
|