{"id":22218982,"url":"https://github.com/ajamous/badgeapi","last_synced_at":"2025-03-25T07:23:59.195Z","repository":{"id":240835521,"uuid":"638939338","full_name":"ajamous/badgeapi","owner":"ajamous","description":"API that creates badges for exhibitions, conferences, meetups.","archived":false,"fork":false,"pushed_at":"2023-05-10T12:59:50.000Z","size":9544,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-20T02:49:11.941Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ajamous.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}},"created_at":"2023-05-10T12:28:16.000Z","updated_at":"2023-05-11T00:13:05.000Z","dependencies_parsed_at":"2024-05-21T03:30:05.554Z","dependency_job_id":null,"html_url":"https://github.com/ajamous/badgeapi","commit_stats":null,"previous_names":["ajamous/badgeapi"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajamous%2Fbadgeapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajamous%2Fbadgeapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajamous%2Fbadgeapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajamous%2Fbadgeapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ajamous","download_url":"https://codeload.github.com/ajamous/badgeapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245416002,"owners_count":20611652,"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":"2024-12-02T22:30:03.747Z","updated_at":"2025-03-25T07:23:59.153Z","avatar_url":"https://github.com/ajamous.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Badgeapi (Visitor Management System API)\n\nThis is an API for a visitor management system that allows registering new visitors and generating a ticket with a unique QR code that can be used for verification.\n\n**Dependencies**\n\nThis project requires the following dependencies:\n\n```json\n\n{\n  \"dependencies\": {\n    \"cors\": \"^2.8.5\",\n    \"body-parser\": \"^1.19.0\",\n    \"express\": \"^4.17.2\",\n    \"sequelize\": \"^6.6.5\",\n    \"uuid\": \"^8.3.2\",\n    \"qrcode\": \"^1.4.4\",\n    \"fs\": \"0.0.1-security\"\n  }\n\n```\n\nRegister\nThis endpoint is used to register a new visitor.\n\n\n```shell\nPOST /register\n\n```\n\nRequest body:\n\n```json\n\n{\n  \"name\": \"John Doe\",\n  \"phone\": \"555-1234\",\n  \"email\": \"john.doe@example.com\",\n  \"company\": \"Acme Inc.\"\n}\n\n\n```\n\nResponse\n\n```json\n{\n  \"success\": true,\n  \"ticket\": {\n    \"id\": \"6ddad93a-4f86-4ab6-9f5d-9db692fa1d24\",\n    \"name\": \"John Doe\",\n    \"phone\": \"555-1234\",\n    \"email\": \"john.doe@example.com\",\n    \"company\": \"Acme Inc.\",\n    \"registeredAt\": \"2023-05-10T18:30:00.000Z\",\n    \"qrcodeDataURL\": \"data:image/png;base64,iVBORw0KGg...\"\n  }\n}\n\n```\n\n## Verify\n\nThis endpoint is used to verify the ticket\n\n```shell\nGET /verify/:ticketId\n```\n\nResponse:\n\n```json\n{\n  \"success\": true,\n  \"ticket\": {\n    \"id\": \"6ddad93a-4f86-4ab6-9f5d-9db692fa1d24\",\n    \"name\": \"John Doe\",\n    \"phone\": \"555-1234\",\n    \"email\": \"john.doe@example.com\",\n    \"company\": \"Acme Inc.\",\n    \"registeredAt\": \"2023-05-10T18:30:00.000Z\",\n    \"Status\": \"PASS\"\n  }\n}\n\n\n```\n\nGenerated Badge Sample:\n\n\u003cimg width=\"619\" alt=\"Screenshot 2023-05-10 at 3 44 10 PM\" src=\"https://github.com/ajamous/badgeapi/assets/19316784/972dc418-0d4f-4e50-92b5-cd7668568726\"\u003e\n\n\n\n**How to run the project**\n\n- Clone the repository.\n- Install the dependencies with npm install.\n- Start the server with npm start.\n- The API will be available at http://localhost:3000.\n\n**License**\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajamous%2Fbadgeapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fajamous%2Fbadgeapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajamous%2Fbadgeapi/lists"}