If this is your first time doing something like this, or you're having trouble installing, try the Detailed Installation Walkthrough.
Evidence requires NPM
Version 7 or higher, and Node.js
Version 14 or higher.
You can check which version you have using
npm -v and
Install the latest version with
npm install -g npm@latest
Install & Launch
- With dbt
npx degit evidence-dev/template my-project
npm run dev
Open your browser and go to http://localhost:3000
template project running in your browser contains a tutorial on how to use Evidence.
npx degit evidence-dev/template reports
npm --prefix ./reports install
npm --prefix ./reports run dev
If you use dbt, it is suggested (but not required) that you install Evidence inside your dbt project, inside a folder called
reports, thereby creating a monorepo.
This currently needs to be done from the terminal, rather than from the dbt Cloud UI.
Then you can make changes across your modelling layer (in
/models) and your reporting layer (in
reports) in the same commits.
Evidence provides a development Docker image.
See our Docker Development Environment repository for instructions.
(Optional) VS Code Extension
If you use VS Code, the Evidence VS Code Extension adds syntax highlighting and basic autocomplete for 'Evidence flavoured' markdown. You can install the extension from the the VS Code marketplace.