Getting Started with Reviewpad

This page will help you get started with Reviewpad. You'll be up and running in a flick!

Welcome to Reviewpad!

Reviewpad is a team collaboration tool for code reviews fully integrated with your code host. We currently support GitHub.com, GitHub Enterprise, GitLab.com and GitLab Self-Hosted. Get in touch if you would like to use Reviewpad with another code host.

If you want to deploy Reviewpad in a server to your team, or if you plan to work with large repositories, check the guide Deploying Reviewpad to your Team. Otherwise, keep going and enjoy it!

Quickstart

Run this command in your terminal:

docker run -d -p 8080:8080 -p 3000:3000 exploredev/reviewpad:latest

Reviewpad will be available in your browser at ↗︎ http://localhost:8080 The first account created will be the administrator.

ℹ️

By running this command you're agreeing with ↗︎ Reviewpad's Terms and Conditions

Note: You can get docker ↗︎ here

This instance of Reviewpad is intended to be used for testing - it will not handle large repositories, and when the container is killed all data will be lost. If you are interested in running Reviewpad with persistent storage check out the guide Deploying Reviewpad to your Team or contact us.

↗️

For teams or large repositories check out Deploying Reviewpad to your Team

Setup

Once you open Reviewpad, you will see a sign-in form:

Reviewpad Sign in
Reviewpad Sign in

The first account created will be the administrator of Reviewpad. This account can then promote other accounts to administrator (or demote, if necessary).

Create account
Create account

After the account creation, you'll be prompted to log in for the first time and you'll be presented with the first step of the onboarding:

1. Welcome to Reviewpad
1. Welcome to Reviewpad

You can connect to Reviewpad to your code host with an OAuth app, which is especially convenient if you're running a team instance. If you're looking for a quicker connection method you can skip this step.

2. Register to OAuth app
2. Register to OAuth app

You'll be prompted the Client ID , Client Secret, and Redirect URL of your OAuth app. After setting up your OAuth app

2. Register to OAuth app - GitHub
2. Register to OAuth app - GitHub

If you're looking for a quicker setup with your code host, you can simply create a Personal Access Token in your code hosts and set it up in this step.

Once you add a Personal Access Token, Reviewpad automatically associates your user to your code host username. After the onboarding process, you can add multiple Personal Access Tokens for different code hosts. If you need help setting up a Personal Access Token visit

.

3. Connect to code host
3. Connect to code host
3. Connect to code host - GitLab
3. Connect to code host - GitLab

Now you can select which of your projects you want to see on Reviewpad. The projects can be public or private - the only requirement is that the Personal Access Token (or OAuth app) associated with this code host can access it.

4. Import projects
4. Import projects

That's it, if all goes well you should see this page. Hit Let's go and get started!

4. Done
4. Done

You'll be taken to the Project administration page. Here you can add more projects with Add. After you can click Add Custom if you're interested in adding a public projects. If you need help managing projects visit

.

Project Administration Area
Project Administration Area

Administrators will have an accessible log in each Reviewpad page that can be used to inspect and share in case of issues.

Reviewpad Log
Reviewpad Log

And that’s it! You are now able to enjoy code reviews for this repository in Reviewpad. Of course, you can add more repositories in this (or other) code hosts.