Skip to content

Getting started

Jump to bottom
Tim Buchholz edited this page Jan 26, 2021 · 35 revisions

Quick Start

Requirements

It may work with older Versions, but it was never tested with any other versions.

How to Run

Setup with Docker

  • Setup Docker on your machine and run these commands:
    • cd docker/deploy
    • docker-compose build
    • docker-compose up -d

Setup with Docker (only Database)

Setup Docker on your machine and run these commands:

  • cd docker/development
  • docker-compose up -d

This will only setup the needed database and expose it on port5432.

It may be beneficial if you want to run Front- and Backend directly from your terminal without going through the hassle of setting up postgres.

Setup without Docker

  • Create the Postgres-DB with the provided Script here
  • Install Node-Dependencies
cd backend/
yarn install
yarn start

cd ../frontend/
yarn install
yarn start

Swagger API Documentation is available under http://localhost:BackendPort/api-docs/

  • Edit Configuration-Files:

    • Backend: Copy .env.bkup to .env in the same folder and change its contents to match your configuration
    • Frontend: Edit .env.development & .env.production to match your Configuration
      • .env.development is used, when the app is started via yarn start
      • .env.production is used, when the app is built using yarn build

    Our Documentation explains every used parameter, if you have any questions regarding them.

  • Start Dev-Version: Run yarn start in the directories for backend and frontend in two separate Terminals. When you get Errors with MacOS see this Known-Issues.

  • Optimized Production Build:

    • Frontend:

      Run yarn build & npx serve build -l PORT, where PORT is the Port you want your Application to be run on

    • Backend:

      Run yarn babel-node

  • Note: In Linux you can use screen to run the project, without killing the process, when leaving the terminal

screen
cd ./...../frontend
npx serve build -l PORT

ctrl+a, ctrl+d (to detach from screen)

screen
cd ./...../backend
yarn start

ctrl+a, ctrl+d (to detach from screen)
Clone this wiki locally