The easiest way to get started with Evidence is to use the VSCode Extension.
- Install Evidence from the VSCode Marketplace
- Open the Command Palette (
Ctrl/Cmd + Shift + P) and enter
Evidence: New Evidence Project
Start Evidencein the bottom status bar
- This will install required dependencies and start the Evidence server
- You should see a browser window open automatically with your app preview
- On Windows, this step can take a couple of minutes the first time
- Make changes to a markdown file and save the file to see the updates in your browser window
The template project running in your browser contains a tutorial on how to use Evidence.Install VSCode Extension
If you run into any issues, reach out in Slack.
- Command Line
- With dbt
npx degit evidence-dev/template my-project
npm run sources
npm run dev
npx degit evidence-dev/template reports
npm --prefix ./reports install
npm --prefix ./reports run sources
npm --prefix ./reports run dev
You can install Evidence inside your dbt project, inside a folder called
reports, to create a monorepo.
This allows changes across your modelling layer (in
/models) and your reporting layer (in
reports) in the same commits.
This currently needs to be done from the terminal, rather than from the dbt Cloud UI.
Note: Codespaces is much faster on the Desktop app. After the Codespace has booted, select the hamburger menu → Open in VS Code Desktop.
Evidence provides a development Docker image.
See our Docker Development Environment repository for instructions.