Skip to content

Latest commit

 

History

History
104 lines (68 loc) · 3.18 KB

README.md

File metadata and controls

104 lines (68 loc) · 3.18 KB

@striae-org/striae

Striae is a cloud-native forensic annotation application for firearms identification, built with React Router and Cloudflare Workers.

This npm package publishes the Striae application source and deployment scaffolding for teams that run their own Striae environment.

Live Project

What This Package Is

  • A deployable source distribution of Striae app code.
  • A package that includes worker examples and example configuration files.

What This Package Is Not

  • Not a small client SDK.
  • Not a zero-config, ready-to-run desktop app.

npm Package, Installation, and Full Deployment

Striae Package Links

  1. Install the latest package:
npm i @striae-org/striae
  1. Copy the package scaffold into the project root
cp -R node_modules/@striae-org/striae/. .
  1. Reinstall using Striae's own package.json (includes dev deps like wrangler/react-router)
rm -rf node_modules package-lock.json
npm install
  1. Prepare Firebase admin credentials (required before deploy-config can pass)
mkdir -p app/config
cp -f app/config-example/admin-service.json app/config/admin-service.json

  1. Replace app/config/admin-service.json with your actual Firebase service account JSON

  2. Authenticate Cloudflare CLI

npx wrangler login
  1. Run guided config + full deployment
npm run deploy:all

NPM Package Content Policy

This package intentionally includes only non-sensitive defaults and runtime source needed for setup.

Included:

  • app/ source (with app/config-example/)
  • functions/, public/, scripts/
  • Worker package manifests
  • Worker source files except runtime entry files (workers/*/src/*.ts and excluding workers/*/src/*worker.ts)
  • Worker example Wrangler configs (workers/*/wrangler.jsonc.example)
  • Project-level example and build config (.env.example, wrangler.toml.example, tsconfig.json, etc.)

Excluded (by design):

  • Real runtime config under app/config/
  • Real worker config files (for example workers/*/wrangler.jsonc)
  • Local secrets and machine-specific files
  • Extra repository metadata not required for npm consumers

Security Notes

  • Do not commit secrets to app/config/, .env, or worker config files.
  • Use only example files as templates and provide real values in your own private environment.
  • Review release notes for security updates before deployment.

License

See LICENSE and NOTICE.

Support