Next.js Explorer is a browser extension for Google Chrome and Firefox designed to help developers explore and visualize the structure and data of their Next.js applications.
To get started with Next.js Explorer, follow the steps below.
Make sure you have the following installed:
- Node.js (v20 or higher)
- npm or yarn
- Chrome or Firefox for testing the extension
Clone the repository to your local machine:
git clone https://github.com/alcoceba/next.js-explorer.git
cd next.js-explorer
Install the necessary dependencies:
npm install
# or
yarn install
To bundle the project and load it as a Google Chrome extension or Firefox addon:
-
For Chrome:
npm run watch:chrome
This command will bundle the project and watch for changes, allowing you to load it as an extension in Chrome.
-
For Firefox:
npm run watch:firefox
This command will bundle the project and watch for changes, allowing you to load it as an addon in Firefox.
After running one of these commands, follow the steps below to load the extension/addon:
- Open Chrome and go to
chrome://extensions/
. - Enable "Developer mode" (toggle switch in the top-right corner).
- Click on "Load unpacked" and select the
dist/chrome
directory.
- Open Firefox and go to
about:debugging
. - Click on "This Firefox" in the sidebar.
- Click on "Load Temporary Add-on" and select the
dist/firefox/manifest.json
file.
To build the project for production:
-
For Chrome:
npm run build:chrome
This command will create a production-ready bundle for Chrome in the
dist/chrome
directory. -
For Firefox:
npm run build:firefox
This command will create a production-ready bundle for Firefox in the
dist/firefox
directory.
This project is licensed under the BSD 3-Clause License - see the LICENSE file for details.