mirror of
https://github.com/Alfresco/alfresco-content-app.git
synced 2025-07-24 17:31:52 +00:00
[MNT-23257] documentation on Windows support (#3336)
* optimise getting started docs * windows support guide
This commit is contained in:
@@ -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)
|
||||
|
Reference in New Issue
Block a user