KaiVolland / react-geo-baseclient

react-geo-baseclient

FAQ

• How to install?

git submodule update --init --recursive

and then

npm i

• How to start the application?

  • When using shogun2 as backend
    • Set the credentials in .env (see below)
    • Start the app with npm run start-shogun2
  • When using no backend / a static appContext
    • Start the app with npm run start:static

• To start a new project:

  • Create a new folder next to the baseclient package, e.g. "myproject" and add at least a single Main class.
  • Configure the project main view and configs in an .env file located in your project base folder, e.g. in myproject/.env
    • This .env file should look like

## Contents of .env file
# Whether to use source map in webpack dev server or not
USE_SOURCEMAP=true

# The name of the main class
PROJECT_MAIN_CLASS=ProjectMain

# The paths !!! relative to Main Component in react-geo-baseclient/packages/baseclient/src/Main.tsx !!!
PROJECT_MAIN_PATH='../../myproject/'

# The path to the project main reducer (!!! relative from ProjectMain path)
# This config is optional. When not configured, the default reducer of baseclient will be used as usual.
PROJECT_REDUCER_PATH=src/store/myreducers

# resources path relative to webpack config in react-geo-baseclient/packages/baseclient/config
RESOURCES_PATH='../myproject/resources/'

SHOGUN_BACKEND_URL=http://localhost:9876/shogun2-webapp
SHOGUN_USER=admin
SHOGUN_PASS=

# Config file containing keys for customized client title, proxy and loading mask logo
CUSTOM_WEBPACK_CONFIG=myproject/config/webpack.config.js

# Prefix/route of the application the client is served on, e.g. '/baseclient/' for 'https://myproject.org/baseclient/'
APP_PREFIX='/'

# The backend/SHOGun base path, e.g. '/rest/' for 'https://myproject.org/rest/'
BACKEND_PATH='/'

• Place an project package.json which uses previously configured .env file using env-cmd, e.g.

  ...
  "scripts": {
    ...
    "start": "cd ../baseclient/ && env-cmd ../myproject/.env npm run start:static",
    ...
  },
  ...

Notes

• When working with react-geo linked make sure to configure the alias for ol in the webpack.commmon.config.

• Styling is done through CSS, do not use LESS, as it cannot be changed dynamically

  • When using variables, look at or append your new variables to the Theme.css file in the src folder