Skip to content

Latest commit

 

History

History
55 lines (39 loc) · 2.25 KB

README.md

File metadata and controls

55 lines (39 loc) · 2.25 KB

Huishoudboekje Frontend Application

Notice for Windows users:

We use symbolic links to map theme folders. Git can automatically create symlinks, though on Windows, you need to make sure you have some configuration set.

git config core.symlinks true

Also, all files work with Line Feed (LF) line endings. Windows works with Carriage Return Line Feed (CRLF) line endings by default, so we need to change a setting in Git. Just run these commands and you're good to go.

git config core.autocrlf false
git config core.eol lf

Development

The frontend component requires the latest version of Node.js.

  • npm install will install all dependencies that are required to run the app.

Mac / Unix

  • npm start runs the application in development mode.
  • npm run theme {yourThemeName} will install ../theme/{yourThemeName} into public/theme. Installing a theme is optional, the Sloothuizen-theme will be used by default.

Environment

To get started quickly, you can copy .env.sample to .env and everything should be working out of the box.

The following additional configuration options are available to put in your .env file:

EXTEND_ESLINT=true

# If you want your frontend app to talk to your local backend, set the URL to it here.
PROXY=http://localhost:5000

# -= OPTIONAL BELOW =-

# If you want your app to talk to a backend on another host (for example a review branch or your local running backend), set this host (and port) here.
PROXY=https://hhb-518.nlx.reviews

# Authorization through OpenID Connect is not required when you use a local backend in dev mode. For other backends we use a JsonWebToken to authorize directly against the proxy.
# You can obtain your token by logging into the remote application and find your token in the app-token cookie.
AUTH_TOKEN={YOUR_JWT_HERE}

# This prevents your browser window from opening after starting the app.
BROWSER=none

Authorization

Review apps can be used as backend instead of a local setup. The url to be used can be found on the MR page as the View App button. The authentication can be done using a jwt token which can be found in the app-token cookie after a succesful login. Just use that as the value of AUTH_TOKEN in your .env file in /frontend/app.