Skip to content

Commit

Permalink
[MNT-23257] documentation on Windows support (#3336)
Browse files Browse the repository at this point in the history
* optimise getting started docs

* windows support guide
  • Loading branch information
DenysVuika committed Jul 13, 2023
1 parent cab8ea9 commit 1d8368c
Show file tree
Hide file tree
Showing 8 changed files with 123 additions and 74 deletions.
48 changes: 44 additions & 4 deletions docs/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,58 @@ Title: Getting started
Github only: true
---

# Getting started
# Getting Started

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)
- [Building from source](/getting-started/building-from-source)
- [Internationalization (i18n)](/getting-started/internationalization)
- [CORS](/getting-started/cors)
- [Single Sign-On](/getting-started/sso)
- [Navigation](/getting-started/navigation)
- [Using local ADF](/getting-started/using-local-adf)
- [Docker Support](/getting-started/docker)
- [Windows Support](/getting-started/windows)
51 changes: 0 additions & 51 deletions docs/getting-started/building-from-source.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/getting-started/prerequisites.md

This file was deleted.

77 changes: 77 additions & 0 deletions docs/getting-started/windows.md
Original file line number Diff line number Diff line change
@@ -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 added docs/images/windows-github-desktop.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/windows-running-aca.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/windows-vs-code.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 2 additions & 3 deletions docs/toc.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,14 @@
- [Info Drawer](/features/info-drawer)
- [Version Manager](/features/version-manager)
- [Search results](/features/search-results)
- [Getting started](/getting-started/)
- [Prerequisites](/getting-started/prerequisites)
- [Building from source](/getting-started/building-from-source)
- [Getting Started](/getting-started/)
- [Internationalization (i18n)](/getting-started/internationalization)
- [CORS](/getting-started/cors)
- [Configuration](/configuration/)
- [Navigation](/getting-started/navigation)
- [Local ADF](/getting-started/using-local-adf)
- [Docker Support](/getting-started/docker)
- [Windows Support](/getting-started/windows)
- [Extending](/extending/)
- [Extensibility features](/extending/extensibility-features)
- [Extension format](/extending/extension-format)
Expand Down

0 comments on commit 1d8368c

Please sign in to comment.