{"id":26802485,"url":"https://github.com/mschn/boxfish","last_synced_at":"2025-03-29T21:18:23.358Z","repository":{"id":243930923,"uuid":"813811479","full_name":"mschn/boxfish","owner":"mschn","description":null,"archived":false,"fork":false,"pushed_at":"2024-10-16T16:30:33.000Z","size":835,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-18T13:06:08.798Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mschn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2024-06-11T19:39:21.000Z","updated_at":"2024-10-16T16:30:37.000Z","dependencies_parsed_at":"2024-09-14T06:54:06.133Z","dependency_job_id":"c0fa6726-9741-45ba-8e2a-197cc0192d89","html_url":"https://github.com/mschn/boxfish","commit_stats":null,"previous_names":["mschn/boxfish"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mschn%2Fboxfish","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mschn%2Fboxfish/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mschn%2Fboxfish/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mschn%2Fboxfish/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mschn","download_url":"https://codeload.github.com/mschn/boxfish/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246243526,"owners_count":20746312,"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-03-29T21:18:22.855Z","updated_at":"2025-03-29T21:18:23.351Z","avatar_url":"https://github.com/mschn.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Boxfish\n\n[![Unit tests](https://github.com/mschn/boxfish/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/mschn/boxfish/actions/workflows/unit_tests.yml) [![E2E tests](https://github.com/mschn/boxfish/actions/workflows/e2e_tests.yml/badge.svg)](https://github.com/mschn/boxfish/actions/workflows/e2e_tests.yml)\n\nBoxfish is a UI for Docker that runs in a browser.\\\nYou can use it to view images and containers running in your Docker platform.\n\n\u003cimg src=\"ui/public/boxfish.svg\" width=\"128\" /\u003e\n\n## Startup\n\nYou can run boxfish with the following command:\n\n```bash\ndocker run -d --rm \\\n    --name boxfish \\\n    -p 3000:3000 \\\n    -v /var/run/docker.sock:/var/run/docker.sock \\\n    mschnr/boxfish\n```\n\nBoxfish needs to access your docker socket at `/var/run/docker.sock`.\\\nOn some platforms this location can be different.\\\nSee the `run.sh` helper script.\n\nThe boxfish image is hosted here: https://hub.docker.com/repository/docker/mschnr/boxfish/general\n\n## Docker build\n\nYou can build and run the docker image from source instead of pulling from Dockerhub:\n\n```bash\n# build a docker image\nsh build.sh\n# run the docker image\nsh run.sh\n```\n\n## Local developer setup\n\nYou can run Boxfish in dev mode outside docker by running the client and server separately.\\\nThis assumes you have `npm` setup:\n\n```bash\n# Server startup:\ncd server\nnpm i\nnpm run start\n```\n\n```bash\n# UI startup:\ncd ui\nnpm i\nnpm run start\n```\n\n## Built with\n\n- [Angular](https://angular.dev/)\n- [Tanstack Query](https://tanstack.com/query/latest/docs/framework/angular/overview)\n- [PrimeNG](https://primeng.org/)\n- [Fastify](https://fastify.dev/)\n- [dockerode](https://github.com/apocas/dockerode)\n- [Xterm.js](https://github.com/xtermjs/xterm.js)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmschn%2Fboxfish","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmschn%2Fboxfish","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmschn%2Fboxfish/lists"}