Skip to content
This repository was archived by the owner on Dec 23, 2020. It is now read-only.

thinkverse/contributors

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

39 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Contributors 🎩

Get an image of your lovely contributors

Visits Badge GitHub last commit JavaScript Style Guide GitHub license

Get an image of your amazing contributors that is perfect for your README. πŸ˜€

Information πŸ€“

For now the public API only returns the first 100 results, including bots.

Example 🀘

Here's an example using one of my favorite projects VueJS.

VueJS's amazing contributors

Usage πŸŽ‰

Paste this markdown in your README.

[![Our amazing contributors](https://contributors.thinkverse.vercel.app/api/contributors?org={organization}&repo={repository})](https://github.com/thinkverse/contributors)

Change {organization} and {repository} with your information.

Parameters πŸ‘

  • org - Your organization e.g. vuejs
    • default : thinkverse
  • repo - Your repository e.g. vue
    • default : contributors
  • bots - Include bots? e.g. false
    • default : true

Contribute 😎

git clone https://github.com/thinkverse/contributors contributors-dev
cd contributors-dev && yarn install
cp .env.example .env

Update enviroment variables

Generate your personal token under your GitHub settings/tokens and switch the GITHUB_TOKEN with that and add your organization/username to GITHUB_ID

Note You will need some way to run serverless functions locally, this project uses vercel.

yarn global add vercel

Now you will become one of our contributors. πŸ‘

My amazing contributors

Generate full list of avatars πŸ”₯

⚠️ Un comment the code inside api/avatars.js

⚠️ Use at your own risk since it can time out your api.

About

Get an image of your lovely contributors. πŸ”₯

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Sponsor this project

Contributors 2

  •  
  •