License & contributing

License

The SyncBins App monorepo (server, web, shared, docker) is MIT licensed — see package metadata in the repo.

• SyncBins and syncbins.com are the product brand.
• Self-hosters may run, modify, and redistribute the server under MIT terms.
• Documentation in SyncBins/Docs follows the same open contribution model unless noted otherwise in that repo.

This is not legal advice. Read the full LICENSE file in each repository you use.

Contributing code

1. Fork and clone SyncBins/App.
2. npm install then npm run dev:compose (or native dev — see App README).
3. Make focused changes; match existing style.
4. npm test and npm run typecheck before opening a PR.
5. Use case checklist: docs/USE_CASES.md in the App repo.

Workspace notes: server/README.md, web/README.md.

Contributing documentation

Docs live in SyncBins/Docs. Every page has an Edit page link to GitHub.

Rules we follow:

• Code wins — App/shared/src/*.ts is the API/protocol source of truth.
• No wishlist as fact — document shipped behavior; put futures on Roadmap.
• Screenshots — use INSERT SCREENSHOT HERE until assets land.

Local preview:

cd Docs
npm install
npm run dev    # http://localhost:4321

Brief for writers: KNOWLEDGE-BASE.md in the Docs repo.

MCP server

The MCP package (@syncbins/mcp) lives in a separate repository. Pair it like any device — MCP server.

Going deeper

Self-hosting quick start Run your own box without forking.

REST API Build on the HTTP contract.