https://github.com/danielroe/nuxt-timings-module
https://github.com/danielroe/nuxt-timings-module
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/danielroe/nuxt-timings-module
- Owner: danielroe
- License: mit
- Archived: true
- Created: 2021-03-06T22:55:21.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-12T22:29:23.000Z (over 1 year ago)
- Last Synced: 2024-10-30T05:07:38.840Z (over 1 year ago)
- Language: TypeScript
- Size: 2.89 MB
- Stars: 33
- Watchers: 3
- Forks: 3
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://timings.nuxtjs.org)
# nuxt-timings
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
[![Codecov][codecov-src]][codecov-href]
[![License][license-src]][license-href]
> Full visibility into your Nuxt render time for optimising performance
## Features
- Uses Nuxt `server.timings` to inject additional timings
- Adds timings for Nuxt plugins and Vuex actions/mutations
## Quick setup
1. Add `nuxt-timings` dependency to your project
```bash
yarn add nuxt-timings # or npm install nuxt-timings
```
2. Add `nuxt-timings` to the `buildModules` section of `nuxt.config.js`
```js
{
buildModules: [
'nuxt-timings',
],
timings: {
// default value
enabled: process.env.NODE_ENV === 'development'
}
}
```
## Development
1. Clone this repository
2. Install dependencies using `yarn install`
3. Start development server using `yarn dev`
## License
[MIT License](./LICENSE)
[npm-version-src]: https://img.shields.io/npm/v/nuxt-timings/latest.svg
[npm-version-href]: https://npmjs.com/package/nuxt-timings
[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-timings.svg
[npm-downloads-href]: https://npm.chart.dev/nuxt-timings
[github-actions-ci-src]: https://github.com/danielroe/nuxt-timings-module/workflows/ci/badge.svg
[github-actions-ci-href]: https://github.com/danielroe/nuxt-timings-module/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/github/danielroe/nuxt-timings-module.svg
[codecov-href]: https://codecov.io/gh/danielroe/nuxt-timings-module
[license-src]: https://img.shields.io/npm/l/nuxt-timings.svg
[license-href]: https://npmjs.com/package/nuxt-timings