/readme-maker-service

Primary LanguageTypeScript

readme-maker-service

Introduction

This badge-maker-service is designed for customized badges which are not provided by simpleicons.org or other services. For example, somebody may want to make unique badges for schools, clubs, or events. In this sense, this service make it possible to make customized badge with special icon, text and color.


How to Use

  1. Prepare query for logo, name, color.
Query DType
logo string
name string
color string
  1. Complete below tag.
<img src="https://github-badge-maker.herokuapp.com/badge?logo=likelion&name=Likelion&color=232F3E"/>

How to Add

  1. Prepare .svg file.
  2. Choose Data URI option at Dropbox menu.
  3. Encode the .svg file into base64.
  4. Put the encoded base64 file in src/badge/assets folder.
  5. Add script to read asset file.
  switch(logo) {
            ...
            case 'queryName':
                var logoDir = `./src/badge/assets/fileName.txt`;
                break;
            ...
        }

Reference

name link
logo https://base64.guru/converter/encode/image/svg
heroku https://dashboard.heroku.com/apps
heroku kaffeine https://kaffeine.herokuapp.com/
Heroku Guide https://velog.io/@kimbiyam/Nest-JS-Heroku%EB%A1%9C-%EB%B0%B0%ED%8F%AC%ED%95%98%EA%B8%B0