[MNT-23257] documentation on Windows support (#3336)

* optimise getting started docs

* windows support guide
This commit is contained in:
Denys Vuika 2023-07-13 13:20:32 +01:00 committed by GitHub
parent cab8ea96b2
commit 1d8368c741
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 123 additions and 74 deletions

View File

@ -3,18 +3,58 @@ Title: Getting started
Github only: true Github only: true
--- ---
# Getting started # Getting Started
Learn how to start developing with the Alfresco Content Application. Learn how to start developing with the Alfresco Content Application.
## Contents > For Microsoft Windows, please refer to [Windows Support](/getting-started/windows) article.
## Prerequisites
| Name | Version |
| --- | --- |
| [Node.js](https://nodejs.org/en/download) | 18.x (see [Node Version Manager](/getting-started/nvm)) |
| Npm | 9.x |
| [ADF](https://github.com/Alfresco/alfresco-ng2-components/blob/develop/docs/release-notes/README.md) | 6.2 |
| [ACS]((https://www.alfresco.com/products/community/download) | 7.4 |
## Building from source
Install the Nx tool (see more at [Nx.dev](https://nx.dev/))
```sh
npm install -g @nrwl/cli
```
Clone the project:
```sh
git clone https://github.com/Alfresco/alfresco-content-app.git
cd alfresco-content-app
```
In the project root folder, create an `.env` file with the following settings:
```yml
BASE_URL="<URL>"
```
Where `<URL>` points to your ACS backend.
Install dependencies and run:
```sh
npm install
npm start
```
## See Also
- [Prerequisites](/getting-started/prerequisites)
- [Node Version Manager](/getting-started/nvm) - [Node Version Manager](/getting-started/nvm)
- [Building from source](/getting-started/building-from-source)
- [Internationalization (i18n)](/getting-started/internationalization) - [Internationalization (i18n)](/getting-started/internationalization)
- [CORS](/getting-started/cors) - [CORS](/getting-started/cors)
- [Single Sign-On](/getting-started/sso) - [Single Sign-On](/getting-started/sso)
- [Navigation](/getting-started/navigation) - [Navigation](/getting-started/navigation)
- [Using local ADF](/getting-started/using-local-adf) - [Using local ADF](/getting-started/using-local-adf)
- [Docker Support](/getting-started/docker) - [Docker Support](/getting-started/docker)
- [Windows Support](/getting-started/windows)

View File

@ -1,51 +0,0 @@
---
Title: Building from source
---
# Building from source
The Content App is based on [Angular CLI](https://cli.angular.io), and you can use all the commands, generators, and blueprints supported by the CLI.
## Prerequisites for building
- [Node.js](https://nodejs.org/en/) 18.x
- NPM 9.x
- (optional) [Angular CLI](https://cli.angular.io/) 14.x or later
> The Angular CLI libraries are already part of the setup.
> You may want installing it as a global (recommended) tool only if you intend using CLI commands separately.
## Cloning and running
Use the following commands to clone the project, install dependencies and run it.
```sh
git clone https://github.com/Alfresco/alfresco-content-app.git
cd alfresco-content-app
npm install
npm start
```
The application runs at port `4200` by default, and should automatically open in the default browser once the project has compiled.
## Setting up environment variables
You need to set some environment variables to be able to run the local dev server. In the project root folder, create an `.env` file (this is gitignored) with the following data:
```yml
# App config settings
BASE_URL="<URL>"
```
## Proxy settings
The Content App provides a proxy configuration for a local development server that allows you to address specific scenarios with CORS and a native authentication dialog.
You can find settings in the `proxy.conf.js` file in the project `src` directory. By default, settings coming from environment variables have higher priority.
**Note:** The proxy settings get automatically applied every time you run the application with the `npm start` script.
You must restart the application every time you change its settings.
## Running unit tests
Run `npm test` to execute the unit tests via [Karma](https://karma-runner.github.io).

View File

@ -1,16 +0,0 @@
---
Title: Prerequisites
---
# Prerequisites
This application uses the latest releases from Alfresco:
- [Alfresco ADF (5.0.0)](https://community.alfresco.com/community/application-development-framework/pages/get-started)
- [Alfresco Content Services (6.1)](https://www.alfresco.com/platform/content-services-ecm)
or [Alfresco Community Edition (6.1 - General Availability 201901)](https://www.alfresco.com/products/community/download)
**Note:** You also need [Node.js](https://nodejs.org/en/) (LTS) installed to build it locally from source code.
The latest version of the Alfresco Content platform is required
due to the application using the latest [REST APIs](https://docs.alfresco.com/5.2/pra/1/topics/pra-welcome.html) developments.

View File

@ -0,0 +1,77 @@
---
Title: Windows
---
# Microsoft Windows
Learn how to get started with Microsoft Windows.
## Prerequisites
- [Windows 10 or later](https://www.microsoft.com/en-us/software-download/windows10ISO)
- [Microsoft Visual C++ 2015 Redistributable (x64)](https://aka.ms/vs/17/release/vc_redist.x64.exe)
## Install NodeJS on Windows
Follow the next guide to setup NVM, Node.js, VS Code and Git:
<https://learn.microsoft.com/en-us/windows/dev-environment/javascript/nodejs-on-windows>
Configure NVM to use Node 18
```sh
nvm install 18
nvm use 18
```
## Setup GitHub Desktop (optional)
To simplify your work with GitHub it is recommended to install the GitHub Desktop tool:
[GitHub Desktop | Simple collaboration from your desktop](https://desktop.github.com/)
## Clone Repository
Clone the repository using [GitHub Desktop](https://desktop.github.com/)
![](../images/windows-github-desktop.png)
or with the command line:
```sh
git clone https://github.com/Alfresco/alfresco-content-app.git
cd alfresco-content-app
```
Click the "Open In Visual Studio Code" button or use your IDE of choice.
For VS Code, make sure you install all the recommended extensions coming with the repository:
![](../images/windows-vs-code.png)
## Setup
In the project root folder, create an `.env` file with the `BASE_URL` property pointing to your ACS backend.
```yaml
BASE_URL="https://your.acs.backend.com"
```
> This property is used for the proxy server to redirect all traffic during development process.
In the VS Code Terminal (powershell), install the Nx CLI:
```sh
npm install -g @nrwl/cli
```
## Build and Run
In the VS Code Terminal (powershell), run the following:
```sh
npm install
npm start
```
The application should open at `http://localhost:4200` by default.
![](../images/windows-running-aca.png)

Binary file not shown.

After

Width:  |  Height:  |  Size: 183 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 631 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 316 KiB

View File

@ -10,15 +10,14 @@
- [Info Drawer](/features/info-drawer) - [Info Drawer](/features/info-drawer)
- [Version Manager](/features/version-manager) - [Version Manager](/features/version-manager)
- [Search results](/features/search-results) - [Search results](/features/search-results)
- [Getting started](/getting-started/) - [Getting Started](/getting-started/)
- [Prerequisites](/getting-started/prerequisites)
- [Building from source](/getting-started/building-from-source)
- [Internationalization (i18n)](/getting-started/internationalization) - [Internationalization (i18n)](/getting-started/internationalization)
- [CORS](/getting-started/cors) - [CORS](/getting-started/cors)
- [Configuration](/configuration/) - [Configuration](/configuration/)
- [Navigation](/getting-started/navigation) - [Navigation](/getting-started/navigation)
- [Local ADF](/getting-started/using-local-adf) - [Local ADF](/getting-started/using-local-adf)
- [Docker Support](/getting-started/docker) - [Docker Support](/getting-started/docker)
- [Windows Support](/getting-started/windows)
- [Extending](/extending/) - [Extending](/extending/)
- [Extensibility features](/extending/extensibility-features) - [Extensibility features](/extending/extensibility-features)
- [Extension format](/extending/extension-format) - [Extension format](/extending/extension-format)