# XCMetrics

[XCMetrics](https://xcmetrics.io) is a tool for collecting build metrics from XCode.  
With this plugin, you can view data from XCMetrics directly in Backstage.

![XCMetrics-overview](./docs/XCMetrics-overview.png)

## Getting started

From `packages/app`:

```bash
yarn add @backstage/plugin-xcmetrics
```

In `packages/app/src/App.tsx`, add the following:

```ts
import { XcmetricsPage } from '@backstage/plugin-xcmetrics';
```

```tsx
<FlatRoutes>
  {/* Other routes... */}
  <Route path="/xcmetrics" element={<XcmetricsPage />} />
</FlatRoutes>
```

Add the URL to your XCMetrics backend instance in `app-config.yaml` like so:

```yaml
proxy:
  ...
  '/xcmetrics':
    target: http://127.0.0.1:8080/v1
```

Start Backstage and navigate to `/xcmetrics` to view your build metrics!