{"id":46278008,"url":"https://github.com/idpass/idpass-data-collect","last_synced_at":"2026-03-04T05:01:49.723Z","repository":{"id":298814259,"uuid":"999780669","full_name":"idpass/idpass-data-collect","owner":"idpass","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-02T06:05:36.000Z","size":4576,"stargazers_count":6,"open_issues_count":9,"forks_count":3,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-02T10:52:30.302Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/idpass.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-06-10T19:20:58.000Z","updated_at":"2025-10-30T02:54:12.000Z","dependencies_parsed_at":"2025-09-10T09:22:49.959Z","dependency_job_id":"951071b5-66b7-486d-98b8-783af07f1604","html_url":"https://github.com/idpass/idpass-data-collect","commit_stats":null,"previous_names":["idpass/idpass-data-collect"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/idpass/idpass-data-collect","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idpass%2Fidpass-data-collect","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idpass%2Fidpass-data-collect/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idpass%2Fidpass-data-collect/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idpass%2Fidpass-data-collect/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/idpass","download_url":"https://codeload.github.com/idpass/idpass-data-collect/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/idpass%2Fidpass-data-collect/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30071895,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-04T03:25:38.285Z","status":"ssl_error","status_checked_at":"2026-03-04T03:25:05.086Z","response_time":59,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-03-04T05:01:47.804Z","updated_at":"2026-03-04T05:01:49.715Z","avatar_url":"https://github.com/idpass.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ID PASS DataCollect\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)\n[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue)](https://www.typescriptlang.org/)\n[![Node.js](https://img.shields.io/badge/Node.js-20.x-green)](https://nodejs.org/)\n\n\u003e A robust offline-first data management system for household and beneficiary data with event sourcing and synchronization capabilities\n\n## 🚀 Features\n\n- **🔌 Offline-First Architecture** - Works seamlessly without internet using IndexedDB\n- **🔄 Two-Level Synchronization** - Client ↔ Server ↔ External system sync\n- **📝 Event Sourcing** - Complete audit trail of all data changes\n- **🏢 Multi-Tenant Support** - Single backend serving multiple applications\n- **🔐 JWT Authentication** - Secure API access with role-based permissions\n- **🎯 TypeScript Throughout** - Type-safe development experience\n- **📊 Conflict Resolution** - Automatic handling of data conflicts during sync\n- **🔧 Extensible Architecture** - Custom event types and sync adapters\n\n## 📦 Project Structure\n\nThis monorepo contains four main packages:\n\n- **`packages/datacollect`** - Core library for offline data management\n- **`packages/backend`** - Central sync server with PostgreSQL\n- **`packages/admin`** - Vue.js admin interface for server management\n- **`packages/mobile`** - Mobile application built with Vue.js and Capacitor\n\n## 🚀 Quick Start\n\nFor setting up on Docker, see the [docker/README](docker/README.md)\n\n### Prerequisites\n\n- Node.js 20.x\n- PostgreSQL 15+ (for backend)\n- npm or yarn\n\n### Installation\n\n1. Clone the repository:\n\n```bash\ngit clone https://github.com/idpass/idpass-data-collect.git\ncd idpass-data-collect\n```\n\n2. Install dependencies and build:\n\n```bash\n# Install root dependencies\nnpm install\n\n# Build datacollect library\ncd packages/datacollect\nnpm install\nnpm run build\n\n# Install backend dependencies\ncd ../backend\nnpm install\n\n# Install admin dependencies\ncd ../admin\nnpm install\n```\n\n3. Set up environment variables:\n\n```bash\ncd ../..\ncp .env.example .env\n# Edit .env with your configuration\n```\n\n4. Start the development servers:\n\n```bash\n# Terminal 1: Backend server\ncd packages/backend\nnpm run dev\n\n# Terminal 2: Admin interface\ncd packages/admin\nnpm run dev\n```\n\n## 📖 Documentation\n\n- [Getting Started Guide](./website/docs/index.md)\n- [Architecture Overview](./website/docs/architecture/index.md)\n- [API Reference](./website/docs/api/datacollect/README.md)\n- [Deployment Guide](./website/docs/deployment/docker-deployment.md)\n- [Examples](examples/)\n- [Glossary](./website/docs/glossary.md)\n\n## 💻 Basic Usage\n\n```typescript\nimport { EntityDataManager } from \"idpass-data-collect\";\n\n// Initialize the data manager\nconst manager = new EntityDataManager(/* ... */);\n\n// Create a household group\nconst household = await manager.submitForm({\n  type: \"create-group\",\n  data: { name: \"Smith Family\" },\n  // ... other fields\n});\n\n// Add members to household\nconst updated = await manager.submitForm({\n  type: \"add-member\",\n  entityGuid: household.guid,\n  data: {\n    members: [{ name: \"John Smith\", dateOfBirth: \"1980-01-15\" }],\n  },\n  // ... other fields\n});\n```\n\nSee [examples/basic-usage](./website/docs/examples/basic-usage/) for a complete example.\n\n## 🏗️ Architecture\n\n```mermaid\ngraph LR\n    A1[App 1 - DataCollect]\u003c--\u003e B[Backend Server]\n    A2[App 2 - DataCollect] \u003c--\u003e B\n    A3[App 3 - DataCollect] \u003c--\u003e B\n    B \u003c--\u003e C[External Systems]\n    B \u003c--\u003e D[(PostgreSQL)]\n```\n\nThe system uses event sourcing with CQRS pattern:\n\n- **Events** represent immutable changes to entities\n- **Entities** represent current state (Groups and Individuals)\n- **Sync** handles bidirectional data synchronization\n- **Storage Adapters** abstract database operations\n\n## 🧪 Testing\n\n```bash\n# Run all tests\nnpm test\n\n# Run tests for specific package\ncd packages/datacollect \u0026\u0026 npm test\ncd packages/backend \u0026\u0026 npm test\ncd packages/admin \u0026\u0026 npm run test:unit\n\n# Run with coverage\nnpm test -- --coverage\n```\n\n## 🤝 Contributing\n\nWe welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details on:\n\n- Code of Conduct\n- Development setup\n- Submitting pull requests\n- Coding standards\n\n## 📄 License\n\nThis project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.\n\n## 🔗 Links\n\n- [GitHub Repository](https://github.com/idpass/idpass-data-collect)\n- [Issue Tracker](https://github.com/idpass/idpass-data-collect/issues)\n- [Website](https://acn.fr)\n\n## 👥 Authors\n\nDeveloped and maintained by [Association pour la Coopération Numérique](https://acn.fr)\n\n---\n\nFor questions or support, please [open an issue](.github/ISSUE_TEMPLATE) or contact the maintainers.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fidpass%2Fidpass-data-collect","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fidpass%2Fidpass-data-collect","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fidpass%2Fidpass-data-collect/lists"}