<commit_before>---
id: quick-start-guide
title: 'Quick Start Guide'
---

*empty still*<commit_msg>docs(quick-start-guide): add basic guide outline<commit_after>---
id: quick-start-guide
title: 'Quick Start Guide'
---

This Guide will show how to setup this package

## Requirements

- NodeJS: 10.15+
- Typescript: 3.8+ (if used)

:::info
When using NodeJS below 12.10, package `rimraf` needs to be installed (when using cleanup with `force`)
:::

When on Linux, one of the following are required:

- having `lsb-core` installed (or any that provides the `lsb_release` command)
- having an `/etc/os-release` file that is compliant to the [OS-Release Spec](https://www.freedesktop.org/software/systemd/man/os-release.html)
- having an `/etc/*-release` file that is compliant to the [OS-Release Spec](https://www.freedesktop.org/software/systemd/man/os-release.html) (and does not include `lsb`)
- manually specify which version & system should be used

## Normal Server

*needs to be extended*

## ReplicaSet

*needs to be extended*
{'fraction_non_alphanumeric': 0.12815533980582525, 'fraction_numerical': 0.009708737864077669, 'mean_word_length': 4.233502538071066, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4100574', 'n_tokens_mistral': 343, 'n_tokens_neox': 324, 'n_words': 117}