Files
geovisio-website/docs/02_Setup.md

2.0 KiB

Setup

GeoVisio website can be installed through classic method, or using Docker.

Contents

[[TOC]]

Classic install

System requirements

You need to have Nodejs installed Node version : >=18.13.0

You need to have Npm installed

You can use npm or yarn as package manager

Install

The website can be installed locally by retrieving this repository and installing dependencies:

# Retrieve source code
git clone https://gitlab.com/geovisio/website.git
cd website/

# Install dependencies
npm install

Build for production

Before building, you need to define a bit of settings. At least, you have to create a .env file and edit its content.

cp env.example .env

More details about settings can be found in docs here.

Then, building for production can be done with these commands:

npm run build
PORT=3000 npm run start

The website is now available at localhost:3000.

Docker setup

The Docker deployment is a really convenient way to have a Geovisio website running in an easy and fast way. Note that this setup documentation only covers GeoVisio front-end (website), if you also need an API running, please refer to Docker API deployment.

You can use the provided Docker Hub geovisio/website:latest image directly:

docker run \
	-e VITE_API_URL="https://your.geovisio.api/" \
	-p 3000:3000 \
	--name geovisio-website \
	-d \
	geovisio/website:latest

This will run a container bound on localhost:3000.

You can also build the image from the local source with:

docker build -t geovisio/website:latest .

Next steps

You can check out the available settings for your instance.