{"id":28003536,"url":"https://github.com/repronim/reproschema-server","last_synced_at":"2025-05-09T02:07:55.174Z","repository":{"id":277573011,"uuid":"932832588","full_name":"ReproNim/reproschema-server","owner":"ReproNim","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-26T17:45:18.000Z","size":36,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-05-09T02:07:26.679Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ReproNim.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":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-14T15:50:56.000Z","updated_at":"2025-02-26T17:45:22.000Z","dependencies_parsed_at":"2025-02-25T04:41:05.264Z","dependency_job_id":null,"html_url":"https://github.com/ReproNim/reproschema-server","commit_stats":null,"previous_names":["repronim/reproschema-deployment","repronim/reproschema-server"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ReproNim%2Freproschema-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ReproNim%2Freproschema-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ReproNim%2Freproschema-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ReproNim%2Freproschema-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ReproNim","download_url":"https://codeload.github.com/ReproNim/reproschema-server/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253176446,"owners_count":21866143,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":"2025-05-09T02:07:54.233Z","updated_at":"2025-05-09T02:07:55.167Z","avatar_url":"https://github.com/ReproNim.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ReproSchema Deployment Container\n\nA containerized solution for deploying ReproSchema UI with data collection capabilities. Simply provide your schema (either from GitHub or local files) and start collecting data.\n\n## Quick Start\n\n1. Create a `.env` file with your configuration:\n```bash\n# Required\nPROJECT_NAME=my_study          # Name for your deployment\nSCHEMA_SOURCE=local           # 'local' or 'github'\n\n# For GitHub schemas\nGITHUB_REPO=user/repo         # Only needed if SCHEMA_SOURCE=github\nGITHUB_TOKEN=ghp_xxx         # Optional: for private repositories\n\n# Optional\nPORT=3000                    # Default: 3000\n```\n\n2. Start the container:\n\nFor local schema:\n```bash\n# Place your schema files in ./schemas directory\nmkdir schemas\ncp -r my-schema/* schemas/\n\n# Start the container\ndocker compose up -d\n```\n\nFor GitHub schema:\n```bash\n# Start with GitHub repository\nSCHEMA_SOURCE=github GITHUB_REPO=user/repo docker compose up -d\n```\n\n3. Access the UI at `http://localhost:3000`\n\n## Data Storage\n\nParticipant data is automatically stored in a Docker volume named `${PROJECT_NAME}_data`. To backup or export the data:\n\n```bash\n# Export data\ndocker run --rm -v ${PROJECT_NAME}_data:/data -v $(pwd):/backup alpine tar czf /backup/data.tar.gz /data\n```\n\n## Configuration Options\n\n- `SCHEMA_SOURCE`: Source of the schema files\n  - `local`: Use schema files from mounted volume\n  - `github`: Fetch schema from GitHub repository\n- `GITHUB_REPO`: GitHub repository containing schema (format: user/repo)\n- `GITHUB_TOKEN`: GitHub personal access token for private repositories\n- `PORT`: Port to expose the service (default: 3000)\n- `PROJECT_NAME`: Name for the deployment (affects volume names)\n\n## Directory Structure for Local Schema\n\nWhen using `SCHEMA_SOURCE=local`, organize your schema files as follows:\n\n```\nschemas/\n├── protocol.jsonld\n├── activities/\n│   ├── activity1.jsonld\n│   └── activity2.jsonld\n└── items/\n    ├── item1.jsonld\n    └── item2.jsonld\n```\n\n## Examples\n\nCheck the `examples/` directory for sample configurations:\n- `examples/simple-schema`: Basic single-protocol setup\n- `examples/multi-participant`: Setup for multiple participant data collection","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frepronim%2Freproschema-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frepronim%2Freproschema-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frepronim%2Freproschema-server/lists"}