Comment on page

Quick start

The best way to learn how to do research in the exbuilder framework is to jump right in and give it a try! To get started, you'll need to install Docker Desktop.

Your first exbuilder project

Once you have Docker Desktop installed, you can create a new exbuilder project with:
git clone https://github.com/exbuilder/exbuilder.git name-of-your-project
Where name-of-your-project is whatever you want to name your project.

Initial configuration

Before you start your project's containers, you need to make a copy of the sample environment file .env.sample and name it .env. To do this in the terminal, from your project directory, run
cp .env.sample .env

Start your containers

To bring up your containers, from your new project's directory, run
docker-compose up -d --build
Once the containers have been created, the following will be available locally:
default login / password
token: password
login: rstudio, password: password
The jupyter and rstudio containers require passwords, which you can set in your .env file. Work you do inside these containers' work folders will be saved locally inside the analyses folder of your project.

Stop your containers

To bring down the containers, from your project directory, run
docker-compose down
That's all there is to it! After the initial build, you can start and stop your project's containers from Docker Desktop if you prefer.

Video tutorial

Follow along on a video tutorial of these steps!