Quick Start

Set up your server

Install the Build Tracker server in a new repository, separate from your application code that you wish to track:

yarn add @build-tracker/server@latest

Create a configuration file, build-tracker.config.js.

At a minimum, use one of the available database plugins and add the url where your application will be accessible.

For this quick start, we'll use Postgres. We'll assume your database is already up and running.

const withPostgres = require('@build-tracker/plugin-with-postgres').default;
module.exports = withPostgres({
url: 'https://your-build-tracker-app',
pg: {
user: 'myuser',
password: 'mypassword',
host: '',
database: 'buildtracker',

Run the server

yarn bt-server

When the server is run, the Postgres database plugin will automatically create any tables and structures needed.

Your application should now be accessible at the provided url.

Upload your builds

Install the Build Tracker CLI in the same repository as your application code you want to track (not the Server that we set up above):

yarn add @build-tracker/cli@latest

Create a configuration file, build-tracker.config.js

You will need, at a minimum, the applicationUrl string, and artifacts search locations set. For the full set of CLI options, refer to the cli docs.

module.exports = {
applicationUrl: '', // The same as your server config `url`
artifacts: ['dist/**/*.js'], // an Array of glob-style file paths
git commit # ensure you don't have a dirty work tree
yarn build # build your application
yarn bt-cli upload-build

Your build stats will be uploaded to Build Tracker now. Be sure to upload more than one build to start getting the benefits out of the delta-based comparisons that Build Tracker provides!

Recipes and Guides

Want to do more with Build Tracker? Follow along in the Guides section of this documentation.