Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add requirements section #678

Merged
merged 3 commits into from
Jan 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/mapstore.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
- name: "setting up npm"
uses: actions/setup-node@v1
with:
node-version: '12.x'
node-version: '16.x'

- name: "cache node modules"
uses: actions/cache@v1
Expand Down
36 changes: 19 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,39 +9,41 @@ See https://georchestra.geo-solutions.it/ (work in progress)

## Building and install the project

### Prerequisite
### Prerequisite

**1. Clone the repository**
**1. Requirements**

`git clone --recursive https://github.com/georchestra/mapstore2-georchestra.git`
You need to read the relevant requirements documentation according to your installation :

https://docs.mapstore.geosolutionsgroup.com/en/latest/developer-guide/requirements/

To read the appropriate requirements page, open the previous link and select the corresponding MapStore2 release in the bottom right corner.

**2. Install NodeJS**
**2. Clone the repository**

* Suggested NodeJS 12.x, npm 6.x.
* Minimal version : NodeJS >= 10, npm >= 6.
* NodeJS > 14.x is not currently supported
`git clone --recursive https://github.com/georchestra/mapstore2-georchestra.git`

**3. Install NodeJS**

:warning: For minimal you may need to increase used memory limits.

To get more informations about nodejs install :

* Instructions to install Nodejs from package manager : [here](https://nodejs.org/en/download/package-manager/)
* Download source : [here](https://nodejs.org/en/download/)
* Download a specific version : [here](https://nodejs.org/dist/)

**3. Install Java SDK**
* Download a specific version : [here](https://nodejs.org/dist/) (v16 is required)

Install Java SDK, if needed. Java 1.8, 9 and 11 are supported.
**4. Install Java SDK**

You can download them from :
If needed you can download Java here :

* [1.8](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
* [9](https://www.oracle.com/technetwork/java/javase/downloads/java-archive-javase9-3934878.html)
* [11](https://www.oracle.com/technetwork/java/javase/downloads/java-archive-javase11-5116896.html)
* [8 (min)](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)
* [9 (recommended)](https://www.oracle.com/technetwork/java/javase/downloads/java-archive-javase9-3934878.html)
* [11 (max)](https://www.oracle.com/technetwork/java/javase/downloads/java-archive-javase11-5116896.html)

**4. Install Maven**
**5. Install Maven**

Install latest Maven, if needed, from [here](https://maven.apache.org/download.cgi) (version 3.5.2 is required).
Install latest Maven, if needed, from [here](https://maven.apache.org/download.cgi).

### Build

Expand Down
Loading