Topmate `README` Badge

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.

Here's how?

Replace vinitshahdeo in the markdown with your Topmate username. Claim your Topmate link if you haven't yet!

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

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 ⤵

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

Available styles

Type	Badge
`flat` _{This is the default style.}
`flat-square`
`plastic`
`social`
`for-the-badge`

Setup

npm install
npm start

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

API Documentation

GET baseUrl/:username - please refer to the Topmate README Badges public Postman collection 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

The badges are powered by an express app deployed on Heroku. These are generated using a tiny-service written by me: topmate.js

topmate
  .generateBadge(username, style)
  .then((badge) => {
    // here is your badge
  })
  .catch(console.log);

Huge shoutout to Shields.io service for providing badges in the SVG format.

Contributing

Do you want to pitch in? If so, please consider developing a web app that generates the markdown badge dynamically based on the Topmate username entered by the user. There will be an option to copy the markdown text. You can take inspiration from the Badges Generator or Peerlist Badges Generator.

This project is also open for the Hacktoberfest participants.

Local development

The react app is available inside the client/ directory in the feature/web-app.

Run the commands below to build locally 👇

git checkout feature/web-app
cd client/topmate-readme-badge
npm install
npm start

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 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.

Here's markdown badge generator for any Peerlist profile 💚 ➥ peerlist-readme-badge

Support

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

A lot has changed over the years, from being mentored to mentoring. I've always believed in giving back to the community, and Topmate has made it easy for me to connect with my mentees - 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.

Did you love it? Consider giving a ⭐ and share it with your friends! You can also find me on Twitter ⏎