Home deployment overview

Deployment Overview

In production, Evidence is a static site generator. This means it doesn't run queries when someone visits your site, but pre-builds all possible pages as HTML beforehand.

You can host your Evidence project using Evidence Cloud, cloud services like Netlify or Vercel, or your own infrastructure. Evidence does not currently support Github Pages, there is more information on GitHub.

Evidence Cloud

The easiest way to deploy Evidence is on Evidence Cloud. Evidence Cloud is free for public projects, and has paid plans for private projects.

Build Process

Evidence doesn't run new queries each time someone visits one of your reports.

Instead, Evidence runs your queries once, at build time, and statically generates all of the pages in your project. This includes all possible permutations of any paramaterized pages.

You can schedule (or trigger) regular builds of your site to keep it up-to-date with your data warehouse.

This has two benefits for you and your users:

  1. If something goes wrong with your SQL, Evidence just stops building your project, and continues to serve older results.
  2. Your site will be exceptionally fast. Under most conditions, pages will load in milliseconds.

Build Commands

Build

The command npm run build will build a static version of your reports and place them in the build directory.

Build:Strict

The command npm run build:strict is a much less permissive build command. Use this to ensure you never deploy a broken report. This command will fail if:

  • Any SQL query fails. A successful query returning no rows is not a failure
  • Any component renders an error state. A component passed a valid query returning no rows will fail - you can avoid this with an {#if} statement if needed.

Storing Credentials

In production, Evidence expects to find your database credentials in environment variables.

To find the environment variables that you'll need to set for your project:

  1. Run your project in development mode
  2. Visit the settings page
  3. Open the deployment panel, and select your deployment target