Skip to content
This repository has been archived by the owner on Sep 27, 2024. It is now read-only.

Commit

Permalink
Merge pull request #54 from MozillaSocial/fix/glean-readme
Browse files Browse the repository at this point in the history
fix(readme): add build:glean to setup steps, add notes re: telemetry
  • Loading branch information
wtfluckey authored Oct 5, 2023
2 parents b926f28 + 7e63b9f commit 1244fdf
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@ Clone the repository and run on the root folder:

```
pnpm i
pnpm run build:glean
pnpm run dev
```

Expand All @@ -125,9 +126,16 @@ We recommend installing [ni](https://github.com/antfu/ni#ni), that will use the

```
ni
nr build:glean
nr dev
```

### Telemetry

*Note: This section is a work in progress.*

We are using [glean.js](https://github.com/mozilla/glean.js/) for analytics tracking. Build the necessary generated files by running the `build:glean` script before starting your server.

### Testing

Elk uses [Vitest](https://vitest.dev). You can run the test suite with:
Expand Down

0 comments on commit 1244fdf

Please sign in to comment.