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

Documentation build (#6762)

Browse Source 
* move doc dependency in doctools

* add ignore link

* rebuild doc

* version index

* put it back some deps
This commit is contained in:
Eugenio Romano
2021-03-03 14:08:15 +00:00
committed by GitHub
parent e05c80f04f
commit c3452a4f62
227 changed files with 6994 additions and 4146 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/getting-started.md
View File

@@ -3,18 +3,15 @@ Title: Getting started (as developer) with Alfresco ADF-based applications
Level: Basic
---
In this tutorial you are going to learn how to launch a fully-featured ADF-based application on your development environment, starting from the source code, with the purpose to have a first experience with the development principles and the best practices suggested to create front-end applications working on top of the Alfresco backend services.
The stack chosen for this initial task is the Open Source version of the front-end application. In the bonus section you can try the same exercise with the Enterprise version (available for Alfresco customers and partners only).
# Prerequisites and requirements
The first thing to do is to check the prerequisites and the requirements to run the front-end application directly into a development environment.
More in particular check that you have:
- Alfresco Content Services (alias ACS) Community or Enterprise edition up and running (identify the URL that will be required as configuration).
- The latest lts version of NodeJs.
- A recent (and supported) version of a browser (see here for further details).
- Alfresco Content Services (alias ACS) Community or Enterprise edition up and running (identify the URL that will be required as configuration).
- The latest lts version of NodeJs.
- A recent (and supported) version of a browser (see here for further details).
# Cloning and launching the front-end application
@@ -26,7 +23,7 @@ Once done, enter the alfresco-content-app folder and create a file named .env wi
`API_CONTENT_HOST="https://..."`
Run `npm install` and then `npm start` to get the application up and running. The application will be available at the URL http://localhost:4200 and the credentials are the ones required by ACS.
Run `npm install` and then `npm start` to get the application up and running. The application will be available at the URL <http://localhost:4200> and the credentials are the ones required by ACS.
Congratulations! You now have the Alfresco Content App running in development mode into your development environment.
@@ -36,7 +33,6 @@ If you have any issue, don’t worry! There is an entire community available to
In case of problems raise a question into the [Alfresco Forum](https://hub.alfresco.com/ "https://hub.alfresco.com/") (Application Development Framework section) or connect with the developers into the [Alfresco Gitter channel](https://alfresco.atlassian.net/wiki/spaces/PM/overview "https://alfresco.atlassian.net/wiki/spaces/PM/overview").
# Bonus: Use the Enterprise stack instead of the Open Source
If you are an Alfresco Customer or an Official Partner, you might be interested in using the Enterprise stack instead of the Open Source introduced above. The changes to the tasks are not too many and you can try to do the same exercise with the following changes.
@@ -47,10 +43,10 @@ If you are an Alfresco Customer or an Official Partner, you might be interested
AUTH_TYPE="BASIC"
PROVIDER="ECM"
API_CONTENT_HOST="https://..."
API_PROCESS_HOST="https://..."
OAUTH_HOST="https://.../auth/realms/alfresco"
E2E_HOST="http://localhost:4200"
API_CONTENT_HOST="<https://...>"
API_PROCESS_HOST="<https://...>"
OAUTH_HOST="<https://.../auth/realms/alfresco>"
E2E_HOST="<http://localhost:4200>"
ADMIN_EMAIL="..."
ADMIN_PASSWORD="..."
ADF_PATH="../alfresco-ng2-components"