Onboarding

This document was generated from 'src/documentation/print-onboarding-wiki.ts' on 2025-05-20, 08:37:59 UTC presenting an overview of flowR's developer onboarding process (v2.2.12). Please do not edit this file/wiki page directly.

To get started developing on flowR, we recommend carefully reading the following pages:

• 💻 Setting up the flowR development environment. This page explains how to install R and Node.js.
• 💖 Contributing guidelines. This page also includes information about how to set up git-lfs and several git hooks.

⌛ TL;DR

The most important steps to get the flowR development environment set up (after installing R and Node.js) can be seen below. For convenience, they can be executed all at once using the following command:

npm run setup:dev

If you want to execute the steps manually, please follow the instructions below:

# Installing git-lfs for your current user (if you haven't already)
git lfs install
# Cloning the repository
git clone https://github.com/flowr-analysis/flowr.git
# Installing dependencies
npm ci
# Configuring git hooks
git config --local core.hooksPath .githooks/
# Test if the git hooks are working correctly
# Running this command should lint the code
git push --dry-run