├── Procfile ├── img └── charmful0x-example.png ├── src ├── utils │ ├── getPoaps.js │ └── processPoaps.js └── server.js ├── package.json ├── LICENSE ├── README.md └── .gitignore /Procfile: -------------------------------------------------------------------------------- 1 | web: node ./src/server.js -------------------------------------------------------------------------------- /img/charmful0x-example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/charmful0x/gitpoap-gh-badge/HEAD/img/charmful0x-example.png -------------------------------------------------------------------------------- /src/utils/getPoaps.js: -------------------------------------------------------------------------------- 1 | import axios from "axios"; 2 | 3 | export async function poapsOf(github_handle) { 4 | try { 5 | const poapsClaimed = ( 6 | await axios.get( 7 | `https://public-api.gitpoap.io/v1/github/user/${github_handle}/gitpoaps?status=claimed` 8 | ) 9 | )?.data; 10 | const poapsUnclaimed = ( 11 | await axios.get( 12 | `https://public-api.gitpoap.io/v1/github/user/${github_handle}/gitpoaps?status=unclaimed` 13 | ) 14 | )?.data; 15 | return poapsClaimed.concat(poapsUnclaimed); 16 | } catch (error) { 17 | return []; 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /src/server.js: -------------------------------------------------------------------------------- 1 | import { getPoapsRes } from "./utils/processPoaps.js"; 2 | import express from "express"; 3 | import cors from "cors"; 4 | 5 | const app = express(); 6 | const port = process.env.PORT || 3000; 7 | 8 | app.use(express.static("public")); 9 | 10 | app.use( 11 | cors({ 12 | origin: "*", 13 | }) 14 | ); 15 | app.set("view engine", "ejs"); 16 | 17 | app.get("/badges/:username/:badge_size?", async (req, res) => { 18 | res.setHeader("Content-Type", "text/plain"); 19 | const response = await getPoapsRes( 20 | req.params.username, 21 | req.params.badge_size 22 | ); 23 | res.send(response); 24 | }); 25 | 26 | app.listen(port, async () => { 27 | console.log(`listening at PORT:${port}`); 28 | }); 29 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "gitpoap-gh-badge", 3 | "version": "0.0.2", 4 | "description": "badge generator for github READMEs", 5 | "main": "./src/server.js", 6 | "type": "module", 7 | "scripts": { 8 | "start": "node ./src/server.js" 9 | }, 10 | "repository": { 11 | "type": "git", 12 | "url": "git+https://github.com/charmful0x/gitpoap-gh-badge.git" 13 | }, 14 | "keywords": [ 15 | "gitpoap", 16 | "poap", 17 | "ethereum" 18 | ], 19 | "author": "charmful0x", 20 | "license": "MIT", 21 | "bugs": { 22 | "url": "https://github.com/charmful0x/gitpoap-gh-badge/issues" 23 | }, 24 | "homepage": "https://github.com/charmful0x/gitpoap-gh-badge#readme", 25 | "dependencies": { 26 | "axios": "^0.27.2", 27 | "cors": "^2.8.5", 28 | "express": "^4.18.1", 29 | "github-username-regex": "^1.0.0", 30 | "html-prettify": "^1.0.7" 31 | } 32 | } 33 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2022 Darwin 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /src/utils/processPoaps.js: -------------------------------------------------------------------------------- 1 | import { poapsOf } from "./getPoaps.js"; 2 | import githubUsernameRegex from "github-username-regex"; 3 | import prettify from "html-prettify"; 4 | 5 | export async function getPoapsRes(github_handle, size) { 6 | try { 7 | const badgeSize = handleSize(Number(size)); 8 | const poapObjects = ["

"]; 9 | if (!githubUsernameRegex.test(github_handle)) { 10 | return "invalid github username syntax"; 11 | } 12 | 13 | const poaps = await poapsOf(github_handle); 14 | 15 | for (const poap of poaps) { 16 | const poapObj = `poap `; 17 | poapObjects.push(poapObj); 18 | } 19 | 20 | poapObjects.push("

"); 21 | 22 | if (poapObjects.length <= 2) { 23 | return false; 24 | } 25 | return prettify(poapObjects.join("").trim()); 26 | } catch (error) { 27 | console.log(error); 28 | return false; 29 | } 30 | } 31 | 32 | function handleSize(size) { 33 | if (!size) { 34 | return 150; 35 | } 36 | 37 | if (!Number.isInteger(size) || size < 50) { 38 | return 150; 39 | } 40 | return size; 41 | } 42 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## About 2 | This repo is a SIMPLE static [GitPOAPs](https://www.gitpoap.io/) badge processor. The server fetch the `claimed` and `unclaimed` GitPOAP badge ***on request***. 3 | 4 | ## Build & Run 5 | ```console 6 | git pull https://github.com/charmful0x/gitpoap-gh-badge.git 7 | 8 | cd gitpoap-gh-badge 9 | 10 | npm install . 11 | 12 | npm start 13 | ``` 14 | 15 | ## API endpoint 16 | 17 | - **API URL: https://gitpoap-gh-badge.herokuapp.com** 18 | 19 | 1- fetch POAPs by github username 20 | - `GET /badges/:github_username/:badge_size?` 21 | 22 | The `badge_size` parameter is optional, the default value is 150 (150 * 150) 23 | 24 | Example: https://gitpoap-gh-badge.herokuapp.com/badges/charmful0x 25 | 26 | ## Usage 27 | 28 | After hitting the API endpoint with your github username, the server will respond with an HTML code block, copy and paste that code block in your github's profile README repo (`username/username` repo). [Repo Example](https://github.com/charmful0x/charmful0x) 29 | 30 | ![example](./img/charmful0x-example.png) 31 | 32 |
33 |

34 | poap 41 | poap 48 |

49 |
50 |
51 | 52 | 53 | ## Roadmap 54 | - [ ] dynamic all-in-one badges SVG generator 55 | 56 | ## TechStack 57 | - GitPOAP API: [docs](https://docs.gitpoap.io/) 58 | - Express 59 | 60 | ## License 61 | This project is licensed under the [MIT license](./LICENSE) 62 | 63 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | 9 | # Diagnostic reports (https://nodejs.org/api/report.html) 10 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 11 | 12 | # Runtime data 13 | pids 14 | *.pid 15 | *.seed 16 | *.pid.lock 17 | 18 | # Directory for instrumented libs generated by jscoverage/JSCover 19 | lib-cov 20 | 21 | # Coverage directory used by tools like istanbul 22 | coverage 23 | *.lcov 24 | 25 | # nyc test coverage 26 | .nyc_output 27 | 28 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 29 | .grunt 30 | 31 | # Bower dependency directory (https://bower.io/) 32 | bower_components 33 | 34 | # node-waf configuration 35 | .lock-wscript 36 | 37 | # Compiled binary addons (https://nodejs.org/api/addons.html) 38 | build/Release 39 | 40 | # Dependency directories 41 | node_modules/ 42 | jspm_packages/ 43 | 44 | # TypeScript v1 declaration files 45 | typings/ 46 | 47 | # TypeScript cache 48 | *.tsbuildinfo 49 | 50 | # Optional npm cache directory 51 | .npm 52 | 53 | # Optional eslint cache 54 | .eslintcache 55 | 56 | # Microbundle cache 57 | .rpt2_cache/ 58 | .rts2_cache_cjs/ 59 | .rts2_cache_es/ 60 | .rts2_cache_umd/ 61 | 62 | # Optional REPL history 63 | .node_repl_history 64 | 65 | # Output of 'npm pack' 66 | *.tgz 67 | 68 | # Yarn Integrity file 69 | .yarn-integrity 70 | 71 | # dotenv environment variables file 72 | .env 73 | .env.test 74 | 75 | # parcel-bundler cache (https://parceljs.org/) 76 | .cache 77 | 78 | # Next.js build output 79 | .next 80 | 81 | # Nuxt.js build / generate output 82 | .nuxt 83 | dist 84 | 85 | # Gatsby files 86 | .cache/ 87 | # Comment in the public line in if your project uses Gatsby and *not* Next.js 88 | # https://nextjs.org/blog/next-9-1#public-directory-support 89 | # public 90 | 91 | # vuepress build output 92 | .vuepress/dist 93 | 94 | # Serverless directories 95 | .serverless/ 96 | 97 | # FuseBox cache 98 | .fusebox/ 99 | 100 | # DynamoDB Local files 101 | .dynamodb/ 102 | 103 | # TernJS port file 104 | .tern-port 105 | --------------------------------------------------------------------------------