Skip to content

Installation

Jonbeckas edited this page May 14, 2023 · 8 revisions

From Release

It recomendet to use nodeJS 18.X LTS

Frontend.

See the Configuration site, or the next step

  1. Download latest checkline-frontend-.zip from the releases

  2. Unzip into the webserver root

  3. Configure web server

# nginx
location / {
                try_files $uri$args $uri$args/ /index.html;
        }

Backend

  1. Download latest checkline-backend-.zip from the releases
  2. unzip the downloaded file
  3. Run npm install
  4. Edit configuration (See config section)
  5. start with node ./main.js

Some deployment advices

  • It is highly recommended to tunnel the backend tarffic over an reverse proxy with https support. host
  • Hosting backend/ frontend on other subdomains is UNTESTED
  • Its recommendet to host the backend on a path of the frontends subdomain (Because of CORS)

From Source

Will be edited at major release 1.0

Frontend

Install dependencies

  • Install angular cli: npm install -g @angular/cli
  • Change to frontend folder
  • Run npm install

Change backend path

  • If you want to use the app not in the root directory in an webserver, also change src/index.html and set <base href="/to/your/subdir">.

Build productive

Run npm build --prod --build-optimizer

Run

Just deploy in on your favourite web server. To make the angular router working you may need some configuration changes. e.g. Nginx:

location / {
                try_files $uri$args $uri$args/ /index.html;
        }

With that config ngnix tries to parse paths as arguments for index.html.

Backend

Install dependencies

Run
npm install in the backend folder.

On some devices e.g. the raspberry pi it is necessary to build the argon2 module manualy. For this just run

npm install argon2 --ignore-scripts
npx node-pre-gyp rebuild -C ./node_modules/argon2

For more information see (https://github.com/ranisalt/node-argon2).

Build

Run npm run build:dev. This will create the build folder from where you could start the backend with node build/server/server.js

Clone this wiki locally