{"id":18385998,"url":"https://github.com/catlabinteractive/nfc-socketio","last_synced_at":"2025-10-06T21:33:22.319Z","repository":{"id":54908543,"uuid":"215510569","full_name":"CatLabInteractive/nfc-socketio","owner":"CatLabInteractive","description":"A service to expose NFC read \u0026 write functionality over socket.io","archived":false,"fork":false,"pushed_at":"2025-02-21T13:24:59.000Z","size":82,"stargazers_count":0,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-08-24T22:17:10.222Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CatLabInteractive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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}},"created_at":"2019-10-16T09:35:29.000Z","updated_at":"2025-02-21T13:25:02.000Z","dependencies_parsed_at":"2024-12-24T07:14:01.113Z","dependency_job_id":"be127442-2670-4071-9c01-3b84fae62d30","html_url":"https://github.com/CatLabInteractive/nfc-socketio","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/CatLabInteractive/nfc-socketio","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CatLabInteractive%2Fnfc-socketio","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CatLabInteractive%2Fnfc-socketio/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CatLabInteractive%2Fnfc-socketio/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CatLabInteractive%2Fnfc-socketio/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CatLabInteractive","download_url":"https://codeload.github.com/CatLabInteractive/nfc-socketio/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CatLabInteractive%2Fnfc-socketio/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278685655,"owners_count":26028322,"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-10-06T02:00:05.630Z","response_time":65,"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":"2024-11-06T01:19:52.989Z","updated_at":"2025-10-06T21:33:22.302Z","avatar_url":"https://github.com/CatLabInteractive.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"NFC socket.io server\n====================\n\nA webservice that exposes NFC methods through a socket.io connection.\nCurrently mainly aimed towards reading and writing NDEF messages on NTAG213 for cashless drinks app [CatLab Drinks](https://drinks.catlab.eu).\n\nSetup on Ubuntu\n---------------\nWe are running our service on a Raspberry Pi 3 running Ubuntu, but these instructions should be working on all Ubuntu/Debian machines.\n\n```\nsudo apt install libtool-bin\nsudo apt install libpcsclite1 libpcsclite-dev\nsudo apt install pcscd\nnpm install\n```\n\nMake sure libnfc is working and that you blacklist the required modules.\nhttps://github.com/nfc-tools/libnfc\n\nPassword\n--------\nIn order to prevent unauthorized access to the reader you need to setup a password \nin your .env file (or in your environment variables).\n\n```\ncp .env.example .env\nnano .env\n``` \n\nAnd add a password at ```NFC_PASSWORD=```\n\nStarting the app\n----------------\nNow simply run `node index.js` to start the service.\n\nThe chosen password and selected http port will appear in the terminal window. Enter the password and server ('localhost:3000' - or domain name) \nin your drinks app and check if the NFC label turns green.\n\nSSL\n---\nYour browser will block websites loaded over https from accessing unencrypted websites, so \nin order for your webapp to be able to connect to this service you will need to load the \nwebapp over unencrypted http access, or implement encryption by adding an apache/nginx reverse proxy \nand installing an ssl certificate on top of this service.\n\nLED \u0026 Beeper:\n-------------\nIn order to disable the beeper we need to disable a security measure:\n\nhttps://github.com/pokusew/nfc-pcsc/issues/13\n\nStart on boot\n-------------\nNow make sure the service automatically starts when turning on the system: (We are using PM2, but there are various alternatives)\nhttps://www.digitalocean.com/community/tutorials/how-to-use-pm2-to-setup-a-node-js-production-environment-on-an-ubuntu-vps\n\n```\npm2 startup\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatlabinteractive%2Fnfc-socketio","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcatlabinteractive%2Fnfc-socketio","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatlabinteractive%2Fnfc-socketio/lists"}