Install Evidence

Stand-alone

npx degit evidence-dev/template my-project
cd my-project 
npm install 
npm run dev 

Open your browser and go to http://localhost:3000

With dbt

cd path/to/your/dbt/project
npx degit evidence-dev/template reports
npm --prefix ./reports install
npm --prefix ./reports run dev

If you use dbt, it is suggested you install Evidence inside your dbt project, inside a folder called reports, creating a monorepo.

This currently needs to be done from the terminal, rather than from the dbt Cloud UI.

This allows changes across your modelling layer (in /models) and your reporting layer (in reports) in the same commits.

Open your browser and go to http://localhost:3000

Codespaces

1. In the template repo click the green "Use this template" button, and select "Open in a Codespace".
2. Wait for the codespace to start up
3. In the terminal in the Codespace, run:

npm install 
npm run dev -- --host 0.0.0.0

Note: Codespaces is much faster on the Desktop app. After the Codespace has booted, select the hamburger menu → Open in VS Code Desktop.

Docker

Evidence provides a development Docker image.

See our Docker Development Environment repository for instructions.

---

The template project running in your browser contains a tutorial on how to use Evidence.

Need step by step instructions? Visit our Detailed Installation Walkthrough.

System Requirements

Evidence requires:

• Node.js Version 16.14 or higher
• NPM Version 7 or higher

Check your versions with node -v and npm -v

• Update to the latest npm version with npm install -g npm@latest

Download Node.js + NPM

VS Code Extension

If you use VS Code, we recommend installing the Evidence VSCode Extension. It adds syntax highlighting and autocomplete for Evidence flavoured markdown.