EPCIS Profile Checker

A web application for building, validating, and searching GS1 EPCIS event profiles — enabling supply chain visibility and traceability compliance.

Live Web Application · Event Sentry · Docker Guide

---

Features

Profile Builder Visually create JSON Schema profiles for EPCIS document and event validation

Event Validator Validate EPCIS events against profiles with instant compliance feedback

Snippet Search Search and filter reusable EPCIS event snippets from the library

Getting Started

Run with Docker / Podman

The quickest way to get started:

# Docker
docker pull ghcr.io/openepcis/openepcis-snippet-web:latest
docker run -p 3000:3000 ghcr.io/openepcis/openepcis-snippet-web:latest

# Podman
podman pull ghcr.io/openepcis/openepcis-snippet-web:latest
podman run -p 3000:3000 ghcr.io/openepcis/openepcis-snippet-web:latest

Open http://localhost:3000 in your browser. See the Docker Guide for compose setup and environment variables.

Run from Source

Requires Node.js 18+ and pnpm.

git clone https://github.com/openepcis/openepcis-snippet-web.git
cd openepcis-snippet-web
pnpm install
pnpm dev

Open http://localhost:3000 in your browser.

Build for Production

pnpm build         # Server-side rendered build
pnpm generate      # Static site generation

Development

pnpm dev            # Start dev server at http://localhost:3000
pnpm build          # Production build
pnpm generate       # Static site generation
pnpm lint           # Run ESLint
pnpm clean          # Remove all build artifacts and dependencies

Project Structure

app/
├── pages/              # Route pages (index, profile-builder, event-validator, snippet-search)
├── components/         # Vue components (JsonEditor, config panels, header/footer)
├── composables/        # Reusable logic (GitHub profile fetching, EPC identifiers)
├── data/               # EPCIS field definitions, dimensions, sensor constants
├── types/              # TypeScript interfaces
└── utils/              # Utility functions

Tech Stack

• Nuxt 4 — Vue.js framework
• Nuxt UI — UI components
• Tailwind CSS — Styling
• AJV — JSON Schema validation (multi-draft support)
• CodeMirror 6 — Code editor with JSON syntax

Related

• OpenEPCIS Event Sentry — EPCIS event profiles, JSON Schema snippets, and validation SDK
• GS1 EPCIS Standard — The underlying traceability standard

Contributing

We welcome contributions! Here are ways to get involved:

• Bug Reports — identify and report issues
• Feature Requests — suggest improvements
• Pull Requests — submit code changes
• Documentation — help improve guides

License

Apache License 2.0