Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vinitshahdeo/topmate-readme-badge

Markdown badge generator for your Topmate profile | Style your profile README with Topmate badge to connect with your audience
https://github.com/vinitshahdeo/topmate-readme-badge

badge-generator hacktoberfest javascript markdown readme-badges topmate

Last synced: 2 months ago
JSON representation

Markdown badge generator for your Topmate profile | Style your profile README with Topmate badge to connect with your audience

Host: GitHub
URL: https://github.com/vinitshahdeo/topmate-readme-badge
Owner: vinitshahdeo
License: mit
Created: 2022-10-14T19:19:23.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-01-10T08:23:59.000Z (about 2 years ago)
Last Synced: 2024-05-01T13:55:57.305Z (9 months ago)
Topics: badge-generator, hacktoberfest, javascript, markdown, readme-badges, topmate
Language: JavaScript
Homepage: https://vinitshahdeo.github.io/topmate-readme-badge/
Size: 11.2 MB
Stars: 20
Watchers: 3
Forks: 9
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-github-profile - Topmate Profile Badge

README

        


   Topmate README Badge 


   

   

   



![](./public/images/topmate-readme-cover.png)



   

   

    

   

   

    

   

   

    

   

   

    

   

   

    

   

   

    

   

   

    

   

   

    

   

   

    

   

   


   






Topmate is a platform to connect 1:1 with your audience & monetise your time better. Basically, one link to do it all ➥ topmate.io/vinitshahdeo. Even better, you can now add a markdown badge in your GitHub profile README to connect with your community! If you haven't claimed your topmate link yet, visit topmate.io to join 1000+ creators, experts and mentors creating impact with their time.




  


   

   Try now: topmate-readme-badge.netlify.app

   



## Here's how?

Replace `vinitshahdeo` in the markdown with your Topmate username. **[Claim your Topmate link](https://topmate.io/) if you haven't yet!**

```markdown

[![Topmate](https://topmate-readme-badge.onrender.com/vinitshahdeo)](https://topmate.io/vinitshahdeo)

```

[![Topmate](https://topmate-readme-badge.onrender.com/vinitshahdeo)](https://topmate.io/vinitshahdeo)

➥ **Try it out here**: [topmate-readme-badge.netlify.app](https://topmate-readme-badge.netlify.app/) *^{(Best viewed in Desktop)}*

> ^{**Note**: In case, you're facing issues in accessing the badge using the above API which is deployed on Heroku. This happens once the monthly free dynos hours are exhausted. In such cases, consider using the service hosted on Render. Please replace the base URL from `https://topmate-readme-badge.herokuapp.com` to `https://topmate-readme-badge.onrender.com`.}

## Style your badge 💅

Additionally it supports the styles. **To use a different style**: Replace `flat-square` in the markdown with any of the styles below ⤵

```markdown

![Topmate](https://topmate-readme-badge.onrender.com/vinitshahdeo?style=flat-square)

```

### Available styles

| Type  | Badge  |

|:---|:---|

| `flat` 
 _{This is the default style._{| ![Topmate](https://topmate-readme-badge.onrender.com/vinitshahdeo) |

| `flat-square`  | ![Topmate](https://topmate-readme-badge.onrender.com/vinitshahdeo?style=flat-square)  |

| `plastic`  | ![Topmate](https://topmate-readme-badge.onrender.com/vinitshahdeo?style=plastic)  |

| `social`  | ![Topmate](https://topmate-readme-badge.onrender.com/vinitshahdeo?style=social)  |

| `for-the-badge`  | ![Topmate](https://topmate-readme-badge.onrender.com/vinitshahdeo?style=for-the-badge)  |}}

## Setup

```console

npm install

npm start

```

Run the above command and visit `http://localhost:3000/`

## API Documentation

   

[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/6178851-c863d626-b2e3-49bf-82d0-4e4cb46a089c?action=collection%2Ffork&collection-url=entityId%3D6178851-c863d626-b2e3-49bf-82d0-4e4cb46a089c%26entityType%3Dcollection%26workspaceId%3Ddfda0a54-561a-45a8-b795-18038b8fd159#?env%5Btopmate%5D=W3sia2V5IjoiYmFzZVVybCIsInZhbHVlIjoiaHR0cHM6Ly90b3BtYXRlLXJlYWRtZS1iYWRnZS5oZXJva3VhcHAuY29tIiwiZW5hYmxlZCI6dHJ1ZSwidHlwZSI6ImRlZmF1bHQifV0=)

`GET baseUrl/:username` - please refer to the [Topmate README Badges public Postman collection](https://www.postman.com/restless-rocket-22186/workspace/topmate-readme-badges-api/documentation/6178851-c863d626-b2e3-49bf-82d0-4e4cb46a089c) for the API documentation. Please feel free to fork and use! You can directly run the collection in Postman by using the **Run in Postman** button above.

## Under the hood

  

![Deployed on Heroku](https://img.shields.io/badge/Deployed%20on%20Heroku-430098?style=flat&logo=heroku&logoColor=white)

  

The badges are powered by an express app deployed on Heroku. These are generated using a tiny-service written by me: [topmate.js](https://github.com/vinitshahdeo/topmate-readme-badge/blob/main/services/topmate.js)

  

```js

topmate

  .generateBadge(username, style)

  .then((badge) => {

    // here is your badge

  })

  .catch(console.log);

```

> Huge shoutout to [Shields.io](https://shields.io/) service for providing badges in the SVG format.

### Topmate `README` Badge Generator

[![Netlify Status](https://api.netlify.com/api/v1/badges/0e91f197-4f59-438f-9eae-54ee4beb6ffe/deploy-status)](https://app.netlify.com/sites/topmate-readme-badge/deploys)

> The react app is available inside the `client/` directory in the `feature/web-app`. This is currently deployed using Netlify. Try it our here: [topmate-readme-badge.netlify.app](https://topmate-readme-badge.netlify.app/)

Run the commands below to build locally 👇

```bash

git checkout feature/web-app

cd client/topmate-readme-badge

npm install

npm start

```

## Contributing

This project is also open for the [Hacktoberfest](https://hacktoberfest.com/) participants. Please check out the open [issues](https://github.com/vinitshahdeo/topmate-readme-badge/issues). **Your contributions are most welcome!**

![GitHub Hacktoberfest combined status](https://img.shields.io/github/hacktoberfest/2022/vinitshahdeo/topmate-readme-badge?logo=digitalocean&logoColor=white)

[![Forkers repo roster for @vinitshahdeo/topmate-readme-badge](https://reporoster.com/forks/vinitshahdeo/topmate-readme-badge)](https://github.com/vinitshahdeo/topmate-readme-badge/network/members)

## Similar projects

Peerlist is a community of working professionals focused on building a personal brand, sharing professional content, and finding peers to collaborate with. A [Peerlist profile](https://peerlist.io/vinitshahdeo) can be used as a simple resume or a complete portfolio to showcase your work. You can style your `README.md` with an awesome Peerlist markdown badge.

[![Peerlist](https://peerlist.onrender.com/api/vinitshahdeo)](https://peerlist.io/vinitshahdeo) [![Peerlist Badges Postman Collection](http://img.shields.io/badge/Postman-Collection-orange.svg?style=flat&logo=postman)](https://www.postman.com/restless-rocket-22186/workspace/peerlist-readme-badges/collection/6178851-67cf0bab-e978-4a37-b3ad-a5b3b42bf69e)

Here's `markdown` badge generator for any Peerlist profile 💚 

➥ [peerlist-readme-badge](https://github.com/vinitshahdeo/peerlist-readme-badge)

[![peerlist-readme-badge](https://github-readme-stats.vercel.app/api/pin/?username=vinitshahdeo&repo=peerlist-readme-badge&theme=ayu-mirage)](https://github.com/vinitshahdeo/peerlist-readme-badge)

## Sponsor

The service stops running once 550 free dyno hours on Heroku are exhausted. **[Consider sponsoring](https://github.com/sponsors/vinitshahdeo/) :dollar: me in order to keep this running by upgrading to [Hobby dynos](https://www.heroku.com/pricing) for $7 per dyno per month**. The service will never sleep and you will get 24/7 access to the awesome Topmate.io badges.

[![GitHub Sponsors](https://img.shields.io/github/sponsors/vinitshahdeo?label=Sponsor%20%40vinitshahdeo&logo=github)](https://github.com/sponsors/vinitshahdeo/)

## Author

[![GitHub WidgetBox](https://github-widgetbox.vercel.app/api/profile?username=vinitshahdeo&data=followers,repositories,stars,commits)](https://github.com/vinitshahdeo)

## Acknowledgement

- My gratitude to [Yashvi](https://github.com/yashvi2001) for helping me in building [React app](https://topmate-readme-badge.netlify.app/). Thanks for the [contributions](https://github.com/vinitshahdeo/topmate-readme-badge/pulls?q=is%3Apr+is%3Aclosed+author%3Ayashvi2001).

- Special thanks to [Tejasvi](https://github.com/TejasviArora) for designing the [Figma mocks](https://www.figma.com/file/DGSis1DiZrULEiWydKtpJb/Peerlist?node-id=89%3A6).

## Stargazers :heart:

[![Stargazers repo roster for @vinitshahdeo/topmate-readme-badge](https://reporoster.com/stars/vinitshahdeo/topmate-readme-badge)](https://github.com/vinitshahdeo/topmate-readme-badge/stargazers)

## Are you a student?

With the placement season around the corner and the internship season already started in many colleges, I would like to make myself available to help students in their prep. Since I have been through this phase, I know that this period can be extremely challenging, not to mention mentally exhausting. So I am opening my slots on [topmate.io](https://topmate.io/vinitshahdeo) to help and guide in whatever ways I can. **Find me here: [topmate.io/vinitshahdeo](https://topmate.io/vinitshahdeo)**



   



## Support

Glad to see you here! Let me briefly tell you what has motivated me to build this ⤵

[![Open Source Love](https://badges.frapsoft.com/os/v2/open-source.svg?v=103)](https://github.com/vinitshahdeo/)

   

A lot has changed over the years, from being mentored to mentoring. I've always believed in [giving back to the community](https://vinitshahdeo.dev/mentorship-mock-interviews-and-giving-back-to-the-community), and Topmate has made it easy for me to connect with my mentees - [topmate.io/vinitshahdeo](https://topmate.io/vinitshahdeo). I made this tiny-service to produce `README` badges for my GitHub repositories, which will help me engage with the **open-source** community.

[![](./public/images/vinitshahdeo-topmate.png)](https://vinitshahdeo.dev/mentorship-mock-interviews-and-giving-back-to-the-community)

   

Did you love it? Consider giving a :star: and share it with your friends! You can also find me on [Twitter](https://twitter.com/Vinit_Shahdeo) ⏎