# metrics-catalog-js

> Metrics Catalog is a small web analytics tool to measure your client-side performance metrics.

Latest version **1.1.6** (published 2020-05-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install metrics-catalog-js
pnpm add metrics-catalog-js
yarn add metrics-catalog-js
bun add metrics-catalog-js
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.6 |
| Published | 2020-05-09 |
| First published | 2020-04-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 21.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Doğan Öztürk |
| Maintainers | dodothebird |

## Links

- npm: https://www.npmjs.com/package/metrics-catalog-js
- Repository: https://github.com/doganozturk/metrics-catalog-js
- Homepage: https://github.com/doganozturk/metrics-catalog-js#readme
- Issues: https://github.com/doganozturk/metrics-catalog-js/issues
- npm.io page: https://npm.io/package/metrics-catalog-js

## Recent versions

- 1.1.6 (latest) — 2020-05-09
- 1.1.5 — 2020-05-07
- 1.1.4 — 2020-05-04
- 1.1.3 — 2020-05-01
- 1.1.2 — 2020-04-30
- 1.1.1 — 2020-04-30
- 1.1.0 — 2020-04-30
- 1.0.18 — 2020-04-30
- 1.0.7 — 2020-04-30
- 1.0.0 — 2020-04-30

## README

# MetricsCatalog.js

[![CircleCI](https://circleci.com/gh/doganozturk/metrics-catalog-js/tree/master.svg?style=shield&circle-token=cd068c8a9e6f1b5093de193726ef3b4eb1d4a0cb)](https://circleci.com/gh/doganozturk/metrics-catalog-js/tree/master) [![npm](https://img.shields.io/npm/v/metrics-catalog-js.svg)](https://www.npmjs.com/package/metrics-catalog-js) [![minzipped size](https://badgen.net/bundlephobia/minzip/metrics-catalog-js)](https://badgen.net/bundlephobia/minzip/metrics-catalog-js)

`metrics-catalog-js` is a tiny analytics library for collecting performance data such as TTFB, FCB etc.

## Features
- Measures TTFB, FCP, DomContentLoaded and window Load events.
- Measures network timings for resources such as images, fonts, css, js etc.
- Works in all modern browsers.
- Sends those performance metrics to our API.
- Can be used in any web application.
- Small size < 1KB Gzipped.

## Installation
- If you are using NPM: ```npm install metrics-catalog-js```
- You can also include the script directly. Just download the script from the [dist folder](https://github.com/doganozturk/metrics-catalog-js/tree/master/dist).

## Get started
- Usage with ES6 modules:

```javascript
import { MetricsCatalog } from 'metrics-catalog-js/dist/metrics-catalog.es.js';

const metricsCatalog = new MetricsCatalog({
    host: 'doganozturk.dev',
});

metricsCatalog.init();

```
- Usage in the browser (the `MetricsCatalog` global contains all of the functions):

```html
<script src="metrics-catalog.bundle.js"></script>

<script>
    const metricsCatalog = new MetricsCatalog({
        host: 'doganozturk.dev',
    });

    metricsCatalog.init();
</script>
```

## Compatibility
- Every decent web browser (Chrome, Firefox, Safari, Opera, Microsoft Edge, IE11)

## Examples
- See the demo.html file for a simple example.

## Local development setup
1. Download the repository.
2. Get Node.js v12.16.3 and install it if you haven't already.
3. Use ```npm install``` to install the necessary dependencies.
4. The source code is written in TypeScript in the `src` directory.
5. Run ```npm run build``` to build the library.
6. Run ```npm test``` to run the tests.

## Contribution
Pull requests and feature requests are welcome!

## Author
* **Doğan Öztürk** - [Github](https://github.com/doganozturk)

---
_Source: https://npm.io/package/metrics-catalog-js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._