|
| 1 | +# Evidence on Spaces |
| 2 | + |
| 3 | +**Evidence** is an open-source framework designed for building data-driven applications, reports, and dashboards using SQL and Markdown. With Evidence, you can quickly create decision-support tools, reports, and interactive dashboards without relying on traditional drag-and-drop business intelligence (BI) platforms. |
| 4 | + |
| 5 | +Evidence enables you to: |
| 6 | +- Write reports and dashboards directly in Markdown with SQL-backed components. |
| 7 | +- Integrate data from multiple sources, including SQL databases and APIs. |
| 8 | +- Use templated pages to automatically generate multiple pages based on a single template. |
| 9 | +- Deploy reports seamlessly to various hosting solutions. |
| 10 | + |
| 11 | +Visit [Evidence’s documentation](https://docs.evidence.dev/) for guides, examples, and best practices for using Evidence to create data products. |
| 12 | + |
| 13 | +## Deploy Evidence on Spaces |
| 14 | + |
| 15 | +You can deploy Evidence on Hugging Face Spaces with just a few clicks: |
| 16 | + |
| 17 | +<a href="https://huggingface.co/spaces/evidence-dev/template-app"> |
| 18 | + <img src="https://huggingface.co/datasets/huggingface/badges/resolve/main/deploy-to-spaces-lg.svg" /> |
| 19 | +</a> |
| 20 | + |
| 21 | +Once created, the Space will display `Building` status. Refresh the page if the status doesn't automatically update to `Running`. |
| 22 | + |
| 23 | +Your Evidence app will automatically be deployed on Hugging Face Spaces. |
| 24 | + |
| 25 | +## Editing your Evidence app from the CLI |
| 26 | + |
| 27 | +To edit your app, clone the Space and edit the files locally. |
| 28 | + |
| 29 | +```bash |
| 30 | +git clone https://huggingface.co/spaces/your-username/your-space-name |
| 31 | +cd your-space-name |
| 32 | +npm install |
| 33 | +npm run sources |
| 34 | +npm run dev |
| 35 | +``` |
| 36 | + |
| 37 | +You can then modify pages/index.md to change the content of your app. |
| 38 | + |
| 39 | +## Editing your Evidence app from VS Code |
| 40 | + |
| 41 | +The easiest way to develop with Evidence is using the [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=Evidence.evidence-vscode): |
| 42 | + |
| 43 | +1. Install the extension from the VS Code Marketplace |
| 44 | +2. Open the Command Palette (Ctrl/Cmd + Shift + P) and enter `Evidence: Copy Existing Project` |
| 45 | +3. Paste the URL of the Hugging Face Spaces Evidence app you'd like to copy (e.g. `https://huggingface.co/spaces/your-username/your-space-name`) and press Enter |
| 46 | +4. Select the folder you'd like to clone the project to and press Enter |
| 47 | +5. Press `Start Evidence` in the bottom status bar |
| 48 | + |
| 49 | +Check out the docs for [alternative install methods](https://docs.evidence.dev/getting-started/install-evidence), Github Codespaces, and alongside dbt. |
| 50 | + |
| 51 | +## Learning More |
| 52 | + |
| 53 | +- [Docs](https://docs.evidence.dev/) |
| 54 | +- [Github](https://github.com/evidence-dev/evidence) |
| 55 | +- [Slack Community](https://slack.evidence.dev/) |
| 56 | +- [Evidence Home Page](https://www.evidence.dev) |
0 commit comments