SnowballR

SnowballR is a web-based tool supporting Systematic Literature Reviews (SLR).

SnowballR's use cases

You can find all use cases here.

Getting Started

The fastest way to get started is to use the provided Docker setup. To do so, run the following commands:

git clone git@github.com:SE-UUlm/snowballr-frontend.git
cd snowballr-frontend
git submodule update --init --recursive
docker compose up

Be sure to have the environment variables set or create a .env file in the root directory of the project (see below).

We provide several docker compose profiles for different setups. Without any arguments, a standalone frontend is started. If you don't have a backend server running, you can use the other profiles, which start a frontend that connects to the snowballR mock backend:

• mock-local: Starts the frontend and the mock backend in a local setup.
• mock-public: Starts the frontend with a connection to the deployed mock backend.

Use docker compose --profile <profile> up to start the frontend with the desired profile.

Environment Variables

The app requires a set of environment variables to run. You can set them in a .env file in the root directory of the project. Either create the file manually or copy the provided example:

cp .env.example .env

The environment variables are as follows:

Variable	Required	Default	Description
PUBLIC_API_BASE_URL	✅	-	The URL of the backend API.
PUBLIC_IS_DEV_MODE	❌	false	Whether the app is in development mode. This may enable additional development tooling.
PORT	❌*	4173	The port where the frontend is served
GRPC_PORT	❌*	3000	The port of the mock backend where the native server is listening on
GRPC_WEB_PORT	❌*	3001	The port of the mock backend where the gRPC web proxy is listening on

* only used when using the docker compose profiles.

Building from Source

See our wiki to build the project from source.