{"id":30722635,"url":"https://github.com/kit-data-manager/fair-do-designer","last_synced_at":"2026-05-26T13:35:42.875Z","repository":{"id":301558182,"uuid":"959740360","full_name":"kit-data-manager/fair-do-designer","owner":"kit-data-manager","description":"A client-side web application to generate code for generating PID Records for FAIR DOs.","archived":false,"fork":false,"pushed_at":"2025-09-02T13:30:38.000Z","size":5153,"stargazers_count":0,"open_issues_count":16,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-02T13:36:48.994Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://kit-data-manager.github.io/fair-do-designer/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kit-data-manager.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-04-03T09:21:44.000Z","updated_at":"2025-09-02T11:51:52.000Z","dependencies_parsed_at":"2025-07-18T15:24:17.524Z","dependency_job_id":"b36423cb-95d1-49c9-98d8-25d68286a1e4","html_url":"https://github.com/kit-data-manager/fair-do-designer","commit_stats":null,"previous_names":["kit-data-manager/fair-do-designer"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/kit-data-manager/fair-do-designer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kit-data-manager%2Ffair-do-designer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kit-data-manager%2Ffair-do-designer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kit-data-manager%2Ffair-do-designer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kit-data-manager%2Ffair-do-designer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kit-data-manager","download_url":"https://codeload.github.com/kit-data-manager/fair-do-designer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kit-data-manager%2Ffair-do-designer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273431469,"owners_count":25104510,"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","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":"2025-09-03T11:09:44.545Z","updated_at":"2026-05-26T13:35:42.870Z","avatar_url":"https://github.com/kit-data-manager.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FAIR DO Designer\n\n[Documentation](https://kit-data-manager.github.io/fair-do-designer/docs) | [Demo (preview / main branch)](https://kit-data-manager.github.io/fair-do-designer/)\n\nThe FAIR DO Designer is a fully client-side tool to create FAIR DOs. It offers a graphical user interface to build together your PID record designs, given examples of available metadata. This design can be applied repeatedly or in batch on the object you'd like to represent as a FAIR DO.\n\nThe current implementation allows exporting designs as python code for integration into existing applications, either directly or as a CLI tool.\n\n## Setup and usage\n\n\u003e Note: You may have noticed a Dockerfile and a docker-compose.yml. Those are currently only meant for development purposes. They will not offer you a production-ready container. Please read this section if you want to build and set it up yourself. We may offer more convenient deployment methods later. Contributions regarding deployment setups (or other aspects) are highly welcome.\n\nThe tool can be self-hosted. We currently offer a [demo / preview on GitHub Pages](https://kit-data-manager.github.io/fair-do-designer/), which is always on the state of the main branch. The [pages workflow](.github/workflows/pages.yml) defines the deployment process, which should allow you to extract answers to more detailed questions. The short version is:\n\n1. Install [bun](https://bun.sh/).\n2. Optional: Set the path that will appear in the URL. E.g. `BASE_PATH=/fair-do-designer`\n3. run `bun run build`.\n4. Serve the `out` directory with any static HTTP server.\n\nPython projects the FAIR DO Designer currently require `uv`. We plan to lower this barrier in future. In the meanwhile it is up to you to adjust the setup to your needs.\n\n## Development\n\nOne way is to use the compose file to run a development container:\n\n```bash\n# with podman:\npodman compose build\npodman compose up -d\n# or, if you prefer docker:\ndocker compose build\ndocker compose up -d\n```\n\nYou can then use vscode to attach to the container.\nThe dev server is available at http://localhost:8080/fair-do-designer.\nThe container comes pre-installed with required tooling like bun and uv.\n\nOtherwise, use these manual steps (install required tooling manually in beforehand):\n\n- `pipx run pre-commit install` to enable all pre-commit hooks.\n- `bun install \u0026\u0026 bun run build \u0026\u0026 bun run dev` to install dependencies and run the service. Avoid using NPM, so we can ensure buns lock file stays up-to-date.\n\n### Python setup\n\nWe use `uv`, which handles the setup properly if you execute a command.\nFor the commands, refer to `.github/workflows/build.yml`.\n\n### Resources\n\n- [Next.js Documentation](https://nextjs.org/docs)\n- [Interactive Next.js tutorial](https://nextjs.org/learn)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkit-data-manager%2Ffair-do-designer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkit-data-manager%2Ffair-do-designer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkit-data-manager%2Ffair-do-designer/lists"}