Skip to content

Latest commit

 

History

History
73 lines (48 loc) · 2.75 KB

README.md

File metadata and controls

73 lines (48 loc) · 2.75 KB
Raw

App for Brontosaurus information system

Documentation

Read and improve the documentation in the docs folder

Developer quickstart

  1. Prerequisity: have Node.js and yarn installed
  2. Clone this repository
  3. Go to working directory: cd bis-frontend
  4. Install dependencies: yarn
  5. Run development version: REACT_APP_API_BASE_URL="https://bis.proxy.mrkvon.org/https://dev.bis.lomic.cz/api/" REACT_APP_CORS_PROXY="https://bis.proxy.mrkvon.org/" yarn start

Production quickstart

  1. Prerequisity: have Node.js and yarn installed
  2. Clone this repository
  3. Go to working directory: cd bis-frontend
  4. Install dependencies: yarn
  5. Build production version (make sure to setup or omit variables as you need): REACT_APP_API_BASE_URL="https://bis.proxy.mrkvon.org/https://dev.bis.lomic.cz/api/" REACT_APP_CORS_PROXY="https://bis.proxy.mrkvon.org/" yarn build
  6. A build/ folder should have been created in the root of your project. Copy the files from build/ to your production server, and serve as single page application for example with nginx.

Configuration

Configuration is done with environment variables. These variables should never contain secrets. After build, they'll be hardcoded in build files and therefore easily discoverable. They serve exclusively to set up configuration constants

To run the app in development version

REACT_APP_VAR1="something" REACT_APP_VAR2="something_else" yarn start

To build the app

REACT_APP_VAR1="something" REACT_APP_VAR2="something_else" yarn build
  • REACT_APP_API_BASE_URL API base url, including trailing slash (default /api/)
  • REACT_APP_SENTRY_DSN a dsn for Sentry setup (disabled when none)
  • REACT_APP_CORS_PROXY A proxy which adds CORS headers to images, including trailing slash (default none)
  • REACT_APP_MAP_TILE_SERVER url template of map tiles

Running locally with a remote proxy

REACT_APP_API_BASE_URL="https://bis.proxy.mrkvon.org/https://dev.bis.lomic.cz/api/" REACT_APP_CORS_PROXY="https://bis.proxy.mrkvon.org/" yarn start

Running locally with a local proxy

Set up the proxy

In a new terminal run:

  1. git clone https://github.com/mrkvon/rdf-proxy.git
  2. cd rdf-proxy
  3. git switch cors-anywhere
  4. yarn
  5. yarn proxy

And the proxy will run on http://localhost:8080 and you can do http://localhost:8080/https://example.com/whatever

Run the app

Use the command: REACT_APP_API_BASE_URL="http://localhost:8080/https://dev.bis.lomic.cz/api/" REACT_APP_CORS_PROXY="http://localhost:8080/" yarn start

Analyzing bundle size

yarn analyze

https://create-react-app.dev/docs/analyzing-the-bundle-size/