Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (28 loc) · 801 Bytes

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 801 Bytes
Raw

Contributing to Visibuild API Demo

Prerequisites

  • Bun v1.0 or later

Local development

git clone https://github.com/visibuild/api-demo
cd api-demo
bun install
bun run dev

The app opens at a random port (shown in the terminal). Open it in your browser.

Project structure

src/
  bun/          Backend logic (API client, OAuth, webhook server, SQLite)
  server/       HTTP + WebSocket server entry point
  mainview/     Browser-side HTML, CSS, TypeScript
  tests/        Bun test files

Running tests

bun test

Submitting a PR

  1. Fork the repo and create a branch: git checkout -b feat/your-feature
  2. Make your changes
  3. Run bun test — all tests must pass
  4. Open a pull request with a clear description of what and why