Skip to main content

Development

You want to contribute to make LOST even better? Great!
Here is what you need to get started:

  1. Build the docker images manually from the source:

    cd docker/compose
    docker compose build

  2. Start the development setup:

    docker compose up

In this setup, these files are used: compose.yaml, compose.override.yaml, logging.compose.yaml and .env.

  • compose.yaml
  • compose.override.yaml
  • logging.compose.yaml
  • .env

Tech Stack​

Frontend​

  1. React
  2. Redux (will be removed in the future)
  3. CoreUI

Backend​

  1. FLASK, SQLAlchemy, RESTplus
  2. Celery
  3. RabbitMQ
  4. MySQL Database

Other​

  1. CI: GitLab-CI
  2. Docker / Docker-Compose

Git Workflow and Versioning​

Branches​

We use version numbers according to Semantic Versioning (see also A-Simple-Guide-To-SemVer). Sematic versioning is also used by prominent open source projects like TensorFlow.

Each Minor version will have its own branch in git for example: 1.0 (Major.Minor) Each developer is responsible that the code he merges will not break our application!

Releases​

Each release will get a tag with Major.Minor.Patch version number in git. Pre-releases are indicated by Major.Minor.Patch-PreReleaseNumber