60 lines (45 loc) · 1.56 KB

Contributing to HarborChain Simulation Prototype

Thank you for your interest in contributing! This repo is intended to stay lightweight and focused on a demo-grade maritime telemetry simulation.

Getting started

Fork the repository and clone your fork.
Install dependencies:
```
npm install
```
Copy .env.example to .env and add any API keys you need.

Branching and commits

Create feature branches from main.
Use descriptive branch names like feature/ai-rate-limit or fix/compliance-validation.
Keep commits small and focused.
Use clear commit messages: fix: validate compliance endpoint payload.

Running the app

Run the dev server:
```
npm run dev
```
Build for production:
```
npm run build
```

Testing

Run tests:
```
npm test
```

Run a specific test file:

npx vitest run src/test/compliance.test.ts --run

Code quality

TypeScript compile checks are available via:
```
npm run lint
```
Keep UI and API semantics explicit: real features should be clearly separated from simulated/demo flows.

Pull requests

Open PRs against main.
Describe what changed and why.
Mention if the PR affects runtime behavior, validation, or CI.

Notes

This repo intentionally keeps blockchain terminology conceptual in the UI. Contributions should preserve transparency between simulation and actual implementation.
The backend uses local SQLite persistence and the AI compliance report endpoint has a mock fallback when GEMINI_API_KEY is not configured.