Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,25 @@ jobs:
run: |
test -s .github/ISSUE_TEMPLATE/feature.md
test -s .github/ISSUE_TEMPLATE/bug.md

scaffold-build:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm

- name: Install dependencies
run: npm ci

- name: Typecheck
run: npm run typecheck

- name: Build
run: npm run build
48 changes: 46 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Dispatchlane is an integration reliability platform for webhook ingestion, outbo
## Status

Dispatchlane is being built in public.
The repository is intentionally being developed with small commits, reviewable PRs, ADRs, and CI discipline from day one.
The repository is intentionally developed with small commits, reviewable pull requests, ADRs, and CI discipline from day one.

## Thesis

Expand All @@ -24,6 +24,19 @@ Dispatchlane exists to handle the hard operational parts of integration traffic:
- delivery inspection and auditability
- health, readiness, metrics, and operator visibility

## Current scaffold scope

The current repository scaffold intentionally includes only:

- Node.js and TypeScript project setup
- Fastify runtime baseline
- environment loading
- minimal API entrypoint
- `GET /healthz`
- CI checks for install, typecheck, and build

The first scaffold does not yet include database, workers, replay, ingestion, or delivery logic.

## Planned v1

- HTTP ingestion endpoint for generic webhook sources
Expand All @@ -46,6 +59,37 @@ Dispatchlane exists to handle the hard operational parts of integration traffic:
- multi-region active-active deployment
- frontend-heavy operator console

## Development

### Requirements

- Node.js 20+

### Install

```bash
npm install
```

### Run locally

```bash
npm run dev
```

### Validate

```bash
npm run typecheck
npm run build
```

### Smoke test

```bash
curl http://localhost:3000/healthz
```

## Engineering principles

- explicit contracts over hidden behaviour
Expand All @@ -58,7 +102,7 @@ Dispatchlane exists to handle the hard operational parts of integration traffic:
## Repository workflow

- `main` stays stable and reviewable
- work lands through short-lived branches after the bootstrap baseline
- work lands through short-lived branches and pull requests
- important design decisions are captured as ADRs
- CI expands with the codebase instead of being added late
- documentation is maintained alongside implementation
Expand Down
Loading
Loading