{"id":30226971,"url":"https://github.com/johnlees/poppunk-web","last_synced_at":"2025-08-14T17:38:27.994Z","repository":{"id":54669685,"uuid":"296365285","full_name":"johnlees/PopPUNK-web","owner":"johnlees","description":"Web version of PopPUNK","archived":false,"fork":false,"pushed_at":"2022-10-23T11:02:26.000Z","size":5622,"stargazers_count":2,"open_issues_count":8,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-08-15T00:30:10.608Z","etag":null,"topics":["epidemiology","frontend","poppunk","sketching"],"latest_commit_sha":null,"homepage":"https://web.poppunk.net","language":"JavaScript","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/johnlees.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}},"created_at":"2020-09-17T15:21:05.000Z","updated_at":"2023-08-15T00:30:10.609Z","dependencies_parsed_at":"2023-01-20T11:01:39.874Z","dependency_job_id":null,"html_url":"https://github.com/johnlees/PopPUNK-web","commit_stats":null,"previous_names":[],"tags_count":0,"template":null,"template_full_name":null,"purl":"pkg:github/johnlees/PopPUNK-web","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnlees%2FPopPUNK-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnlees%2FPopPUNK-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnlees%2FPopPUNK-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnlees%2FPopPUNK-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/johnlees","download_url":"https://codeload.github.com/johnlees/PopPUNK-web/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/johnlees%2FPopPUNK-web/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270458922,"owners_count":24587495,"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-08-14T02:00:10.309Z","response_time":75,"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":["epidemiology","frontend","poppunk","sketching"],"created_at":"2025-08-14T17:38:24.368Z","updated_at":"2025-08-14T17:38:27.986Z","avatar_url":"https://github.com/johnlees.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PopPUNK-web\n\n![Azure Static Web Apps CI/CD](https://github.com/johnlees/PopPUNK-web/workflows/Azure%20Static%20Web%20Apps%20CI/CD/badge.svg?branch=master)\n\n## NOTICE: currently down\n\nPopPUNK-web is temporarily down while we work on an updated and better supported version (beebop).\n\n## Introduction\n\nThis repository holds the source code for the PopPUNK-web application. PopPUNK-web makes use of WebAssembly for in-browser, client-side k-mer sketching, and a Python backend for query assignment and generation of visualisations. As we make use of several languages in a single pipeline, there are a few considerations for development purposes.\n\n## Testing\n\nTo locally host PopPUNK-web in development mode at http://localhost:3000, run:\n```\ngit clone https://github.com/johnlees/PopPUNK-web\ncd PopPUNK-web\nnpm install\nnpm start\n```\nTo test the backend, ensure PopPUNK is installed (https://github.com/johnlees/PopPUNK), open a second terminal and run the Python API using:\n```\ngit clone https://github.com/johnlees/PopPUNK\ncd PopPUNK\npython poppunk_api-runner.py\n```\nThis will run a development server at http://localhost:5000. As this port (5000) is different to that running the frontend (3000), you must specify a proxy in PopPUNK-web so the frontend and backend can communicate. This can be done by adding the following line to ```package.json```:\n```\n\"proxy\": \"http://localhost:5000\"\n```\n\n## Compiling the WebAssembly\n\nThe sketching code is based in C++ and can be found at https://github.com/johnlees/pp-sketchlib. To compile the files necessary for web sketching, you will need to download and activate an emscripten sdk environment (https://emscripten.org/index.html), then compile. This can be done by running:\n```\n# Get the emsdk and pp-sketchlib repos\ngit clone https://github.com/emscripten-core/emsdk.git\ngit clone https://github.com/johnlees/pp-sketchlib\nsource ./emsdk/emsdk_env.sh\n./emsdk/emsdk activate latest\ncd pp-sketchlib/src \u0026\u0026 make web\n```\nThis will build “web_sketch.js” and “web_sketch.wasm” in pp-sketchlib/src/web. These files can then be read by PopPUNK-web when placed in the public directory of the PopPUNK-web bundle.\n\n## Create react app docs\n\n### `npm test`\n\nLaunches the test runner in the interactive watch mode.\u003cbr /\u003e\nSee the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.\n\n### `npm run build`\n\nBuilds the app for production to the `build` folder.\u003cbr /\u003e\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\nThe build is minified and the filenames include the hashes.\u003cbr /\u003e\nYour app is ready to be deployed!\n\nSee the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnlees%2Fpoppunk-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjohnlees%2Fpoppunk-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjohnlees%2Fpoppunk-web/lists"}