Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@striae-org/striae) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@striae-org/striae
Striae is a cloud-native forensic annotation application for firearms identification, built with Remix and Cloudflare Workers.
This npm package publishes the Striae application source and deployment scaffolding for teams that run their own Striae environment.
Live Project
- Application: https://www.striae.org
- Source repository: https://github.com/striae-org/striae
- Releases: https://github.com/striae-org/striae/releases
- Security policy: https://github.com/striae-org/striae/security/policy
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
- npmjs: https://www.npmjs.com/package/@striae-org/striae
- GitHub Packages: https://github.com/orgs/striae-org/packages/npm/package/striae
- Install the latest package:
npm i @striae-org/striae- Copy the package scaffold into the project root
cp -R node_modules/@striae-org/striae/. .- Reinstall using Striae's own package.json (includes dev deps like wrangler/remix)
rm -rf node_modules package-lock.json
npm install- 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.jsonReplace
app/config/admin-service.jsonwith your actual Firebase service account JSONAuthenticate Cloudflare CLI
npx wrangler login- Run guided config + full deployment
npm run deploy:allPublish To npmjs And GitHub Packages
- Verify auth for both registries
npm whoami --registry=https://registry.npmjs.org/
npm whoami --registry=https://npm.pkg.github.com/- Publish current version to npmjs (public)
npm run publish:npm- Publish the same version to GitHub Packages
npm run publish:github- Optional dry-runs before a real release
npm run publish:npm:dry-run
npm run publish:github:dry-run
npm run publish:all:dry-runNPM Package Content Policy
This package intentionally includes only non-sensitive defaults and runtime source needed for setup.
Included:
app/source (withapp/config-example/)functions/,public/,scripts/- Worker package manifests
- Worker source files except runtime entry files (
workers/*/src/*.tsand excludingworkers/*/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
- Support page: https://www.striae.org/support
- Contact: info@striae.org