Skip to content

CONTRIBUTE.md

Latest commit

 

History

History
62 lines (43 loc) · 2.16 KB

CONTRIBUTE.md

File metadata and controls

62 lines (43 loc) · 2.16 KB

Development

This project uses Vite for local development and optimized builds.

Prerequisites

  • Node.js (Version 20+ or 22+ recommended)

Getting Started

  1. Install dependencies: 
    npm install
  2. Start the development server: 
    npm run dev
    The app will be available at http://localhost:5173/.

Why Vite?

  • Instant Updates: Support for Hot Module Replacement (HMR) means changes to JS/CSS are reflected instantly in the browser.
  • Dependency Management: No more manual path tracking or broken internal imports.
  • Automated PWA: Service Worker generation and asset hashing are handled automatically.

Code Quality & Linting

We use a standard stack to ensure code quality and consistency:

Commands

  • Check everything: npm run lint
  • Auto-format code: npm run format (Runs Prettier)
  • Fix JS issues: npm run lint:js -- --fix
  • Fix CSS issues: npm run lint:css -- --fix

Important

A GitHub Action automatically runs these checks on every push and pull request. Please ensure npm run lint passes before committing.

Project Structure

  • /js: Application source code.
  • /public: Static assets (images, manifest, instances.json) that are copied directly to the build folder.
  • index.html: The entry point of the application.
  • vite.config.js: Build and PWA configuration.

Deployment

Deployment is automated via GitHub Actions.

Note

The project uses a relative base path (./) in vite.config.js. This allows the exact same build artifact to work on both Cloudflare Pages (served from root) and GitHub Pages (served from /monochrome/), provided that Hash Routing is used.

  1. Simply push your changes to the main branch.
  2. The Deploy to GitHub Pages workflow will trigger automatically.
  3. It builds the project (npm run build) and publishes the dist/ folder to the deployed-ver branch.