/next-chrome-starter

Next.js Chrome Extension Starter example application that demonstrates how to build a Chrome extension using Next.js. It provides a foundation for developing Chrome extensions with Next.js, React and Node.js

Primary LanguageJavaScriptMIT LicenseMIT

Next.js Chrome Extension Starter 🚀

Next.js Chrome Extension Starter is a demo example application that demonstrates how to build a Chrome extension using Next.js.

Table of Contents ✨

Description

The Next.js Chrome Extension Starter provides a foundation for building Chrome extensions using Next.js, React, and other related technologies. It showcases the integration of Next.js and Chrome extension development by demonstrating a simple application with multiple pages.

Preview

Installation

To install and run Next.js Chrome Extension Starter locally, follow these steps:

  1. Clone this repository:

    git clone https://github.com/ibnzUK/next-chrome-starter.git
  2. Navigate to project directory:

    cd next-chrome-starter
    
  3. Install the dependencies using npm:

    npm install
    

Usage

Usage Locally 🔥

To run the Next.js Chrome Extension Starter locally, follow these steps:

Run the project:

npm run dev

This will run project on your localhost

http://localhost:3000/

Build and Import To Chrome 🔥

To build and import Next.js Chrome Extension Starter to chrome browser, follow these steps:

  1. Build the project:
npm run build

This will run prep and export to create new folder 'out/', and rename '_next' forlder to 'next' (without underscore)

  1. Open Google Chrome and go to chrome://extensions.

  2. Enable the "Developer mode" toggle switch.

  3. Click on "Load unpacked" and select the out folder generated by the build process.

  4. The Next.js Chrome Extension Starter should now be loaded as an unpacked extension in Google Chrome.

Preview

Contributing

Contributions to the Next.js Chrome Extension Starter are welcome! If you find any issues or have suggestions for improvements, please feel free to open an issue or submit a pull request.

License

This project is licensed under the MIT License.

Feel free to customize and modify it based on your specific requirements. Make sure to include any additional information, such as troubleshooting tips or specific Chrome extension functionality, to provide a comprehensive guide for users.

MIT License

Copyright (c) 2023 Justinas Kairys (ibnzUk.eth)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.