danielroe.dev
[READ-ONLY] Mirror of https://github.com/danielroe/nuxt-timings-module.
1.8 kB
64 lines
1[](https://timings.nuxtjs.org)
2
3# nuxt-timings
4
5[![npm version][npm-version-src]][npm-version-href]
6[![npm downloads][npm-downloads-src]][npm-downloads-href]
7[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
8[![Codecov][codecov-src]][codecov-href]
9[![License][license-src]][license-href]
10
11> Full visibility into your Nuxt render time for optimising performance
12
13## Features
14
15- Uses Nuxt `server.timings` to inject additional timings
16- Adds timings for Nuxt plugins and Vuex actions/mutations
17
18## Quick setup
19
201. Add `nuxt-timings` dependency to your project
21
22```bash
23yarn add nuxt-timings # or npm install nuxt-timings
24```
25
262. Add `nuxt-timings` to the `buildModules` section of `nuxt.config.js`
27
28```js
29{
30 buildModules: [
31 'nuxt-timings',
32 ],
33 timings: {
34 // default value
35 enabled: process.env.NODE_ENV === 'development'
36 }
37}
38```
39
40## Development
41
421. Clone this repository
432. Install dependencies using `yarn install`
443. Start development server using `yarn dev`
45
46## License
47
48[MIT License](./LICENSE)
49
50<!-- Badges -->
51[npm-version-src]: https://img.shields.io/npm/v/nuxt-timings/latest.svg
52[npm-version-href]: https://npmjs.com/package/nuxt-timings
53
54[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-timings.svg
55[npm-downloads-href]: https://npm.chart.dev/nuxt-timings
56
57[github-actions-ci-src]: https://github.com/danielroe/nuxt-timings-module/workflows/ci/badge.svg
58[github-actions-ci-href]: https://github.com/danielroe/nuxt-timings-module/actions?query=workflow%3Aci
59
60[codecov-src]: https://img.shields.io/codecov/c/github/danielroe/nuxt-timings-module.svg
61[codecov-href]: https://codecov.io/gh/danielroe/nuxt-timings-module
62
63[license-src]: https://img.shields.io/npm/l/nuxt-timings.svg
64[license-href]: https://npmjs.com/package/nuxt-timings