🔧 Build & Publish

Complete instructions for building the Smart Join extension and publishing the site

Build Extension

1. Install dependencies: npm install
2. Transpile TypeScript and copy extension assets: npm run build:ext
3. The resulting extension will be in the dist/ folder, ready for local loading into your browser

Build the Site (Version Injection)

1. Run npm run build:site — this reads src/manifest.json and creates site/version.html with the current version and release details
2. Preview locally using a static server:
   • npx serve site, or
   • python3 -m http.server 8000 --directory site

Publish to GitHub Pages

This repository includes a GitHub Action that automatically publishes the site/ folder to the gh-pages branch whenever you push to main.

Important Notes

• If you fork this repo, update the homepage/support/privacy URLs in src/manifest.json to point to https://YOUR_USERNAME.github.io/Smart-Join/
• To customize the GitHub Actions deploy behavior, edit .github/workflows/deploy-site.yml
• Make sure all paths in HTML files use relative paths or absolute URLs for proper GitHub Pages hosting