https://github.com/evidence-dev/template
Starter template for new Evidence Projects
https://github.com/evidence-dev/template
evidence
Last synced: about 1 year ago
JSON representation
Starter template for new Evidence Projects
- Host: GitHub
- URL: https://github.com/evidence-dev/template
- Owner: evidence-dev
- Created: 2021-08-23T21:29:36.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-13T23:45:44.000Z (about 1 year ago)
- Last Synced: 2025-04-02T17:11:20.634Z (about 1 year ago)
- Topics: evidence
- Language: JavaScript
- Homepage: https://docs.evidence.dev
- Size: 47.5 MB
- Stars: 25
- Watchers: 2
- Forks: 22
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Evidence Template Project
## Using Codespaces
If you are using this template in Codespaces, click the `Start Evidence` button in the bottom status bar. This will install dependencies and open a preview of your project in your browser - you should get a popup prompting you to open in browser.
Or you can use the following commands to get started:
```bash
npm install
npm run sources
npm run dev -- --host 0.0.0.0
```
See [the CLI docs](https://docs.evidence.dev/cli/) for more command information.
**Note:** Codespaces is much faster on the Desktop app. After the Codespace has booted, select the hamburger menu → Open in VS Code Desktop.
## Get Started from VS Code
The easiest way to get started is using the [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=Evidence.evidence-vscode):
1. Install the extension from the VS Code Marketplace
2. Open the Command Palette (Ctrl/Cmd + Shift + P) and enter `Evidence: New Evidence Project`
3. Click `Start Evidence` in the bottom status bar
## Get Started using the CLI
```bash
npx degit evidence-dev/template my-project
cd my-project
npm install
npm run sources
npm run dev
```
Check out the docs for [alternative install methods](https://docs.evidence.dev/getting-started/install-evidence) including Docker, Github Codespaces, and alongside dbt.
## Learning More
- [Docs](https://docs.evidence.dev/)
- [Github](https://github.com/evidence-dev/evidence)
- [Slack Community](https://slack.evidence.dev/)
- [Evidence Home Page](https://www.evidence.dev)