Skip to content

chienhsiang-hung/next-devtools

 
 

Repository files navigation

Next Devtools

npm version npm downloads License

Enhance Next developer experience

📚 Documentation ⚡️ Try it on StackBlitz

Getting Started

Using Next DevTools in your Next project.

Examples

You can refer to these two projects to use Next DevTools.

You can create a Next.js project using Next DevTools with the following.

# app-router
npx create-next-app@latest nextjs-devtools-app-router --use-npm --example "https://github.com/xinyao27/next-devtools/tree/main/examples/app-router"

# pages-router
npx create-next-app@latest nextjs-devtools-pages-router --use-npm --example "https://github.com/xinyao27/next-devtools/tree/main/examples/pages-router"

Installation

Inside your Next project directory, run the following:

npm i @next-devtools/core

// or

pnpm add @next-devtools/core

next.config

You need to add the following configuration in the next.config file.

const { withNextDevtools } = require('@next-devtools/core/plugin')

module.exports = withNextDevtools({
  // Other Next.js configuration ...
})

NextDevtoolsProvider

app router

You need to add the NextDevtoolsProvider component in the app/layout file.

import { NextDevtoolsProvider } from '@next-devtools/core'

export default function RootLayout({ children }) {
  return (
    <html>
      <body>
        <NextDevtoolsProvider>{children}</NextDevtoolsProvider>
      </body>
    </html>
  )
}

pages router

You need to add the NextDevtoolsProvider component in the pages/_app file.

import { NextDevtoolsProvider } from '@next-devtools/core'

export default function App({ Component, pageProps }) {
  return (
    <NextDevtoolsProvider>
      <Component {...pageProps} />
    </NextDevtoolsProvider>
  )
}

Inspired by NuxtDevtools

Nuxt DevTools is a set of visual tools that help you to know your app better.

Contribution Guide

Please refer to the Contribution Guide.

License

MIT

About

Enhancement Next Developer Experience

Resources

License

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 77.0%
  • CSS 8.6%
  • JavaScript 7.9%
  • SCSS 6.4%
  • Shell 0.1%