LUP4LDN — Frontend Dashboard

Land Use Planning for Land Degradation Neutrality

Winner · GEO-LDN International Technology Innovation Competition (2021)

Live app · Project site

---

About

This repository contains the frontend dashboard of LUP4LDN — the web interface through which stakeholders run a participatory land use planning process for Land Degradation Neutrality (LDN), evaluate land use and land management transition scenarios, and read the results against SDG indicator 15.3.1.

The dashboard is built with the Diamond-React application framework and talks to the LUP4LDN backend API.

Looking for the user-facing guide? End users should start with the LUP4LDN User Guide rather than this repository, which is aimed at developers.

Tech stack

• React (Diamond-React application framework)
• Node.js 14.17.0 LTS / npm 7.13.0 LTS
• Docker for containerised builds

---

Requirements

• Node.js v14.17.0 LTS — Download
• npm v7.13.0 LTS — Download

Getting started

1. Set up the environment

Using nodeenv, create an isolated environment with the required Node version:

nodeenv --prebuilt -n 14.17.0 env

Activate it:

. env/bin/activate

And install the matching npm version:

npm i -g npm@7.13.0

2. Install dependencies

npm install

Note — Font Awesome icons. To use Fortawesome icons, create an .npmrc file and add your token. See the Font Awesome setup instructions.

3. Configure

Copy the example environment file:

cp .env.example .env

Then fill in the values. The most important one is REACT_APP_API_BASE_URL, which points the dashboard at the LUP4LDN backend API.

4. Run locally

npm start

Open localhost:3000 in your browser (it should open automatically).

---

Testing

Run the test suite locally:

npm run test

Docker

Build a Docker image for the project:

docker build . -t scio-lup4ldn-frontend

Run the container:

docker run -d -p 3000:3000 scio-lup4ldn-frontend

Production build

Generate the production-ready app:

npm run build

The build folder will contain all the files needed for deployment.

---

Contributing

Contributions are welcome. Please read CONTRIBUTING.md before opening an issue or a pull request.

Security

To report a vulnerability, please follow the process in SECURITY.md rather than opening a public issue.

Support

For help using the tool, contact SCiO at lup4ldn@scio.systems.

---

License

The source code in this repository is licensed under the GNU General Public License v3.0 (GPL-3.0) — see LICENSE for the full text.

This licence covers the software code only.

Name and logo

"LUP4LDN"™ and the LUP4LDN logo are trademarks of SCiO P.C. and are not licensed under the GPL. If you fork or redistribute a modified version, you must give it a different name and must not use the LUP4LDN name or logo, so that users can always tell the original, SCiO-maintained LUP4LDN apart from independent derivatives.

See TRADEMARK.md for the full name and logo policy.

---

Developed and maintained by SCiO P.C., Athens, Greece