Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.09 KB

development.md

File metadata and controls

48 lines (32 loc) · 1.09 KB

Development Guide

This guide explains how to set up the development environment and contribute to the github-actions-search Chrome extension.

Prerequisites

  • Node.js (version specified in .node-version)
  • pnpm (package manager)
  • Chrome browser for testing

Install dependencies

$ pnpm i

Start dev server

$ pnpm dev

After development server started, chrome browser automatically open.

You can check extension behavior by moving github-actions-search's actions tab.

Other Development Commands

  • pnpm build - Build production bundle
  • pnpm test - Run tests
  • pnpm lint - Run linting
  • pnpm typecheck - Check TypeScript types

Project Structure

  • src/ - Source code
    • content/ - Content scripts injected into GitHub pages
  • public/ - Static assets
  • test/ - Visual Regression Test files
  • dist/ - Build output

Building

To create a production build:

  1. Run pnpm build
  2. The extension will be built to dist/
  3. Load the dist directory as an unpacked extension in Chrome