soroushchehresa / github-readme-linkedin Goto Github PK

📋 A serverless application to get dynamically generated images from your LinkedIn profile on your GitHub READMEs

TypeScript 100.00%

profile-readme dynamic readme-generator readme-generation serverless readme readme-md readme-dynamic vercel-serverless linkedin

github-readme-linkedin's Introduction

GitHub Readme LinkedIn

A serverless application to get dynamically generated images from your LinkedIn profile on your GitHub READMEs!

Usage

If you want to use this project on your GitHub profile, I recommend you fork and deploy it to your own Vercel instance and use this project from your own URLs.

Example

<img src="[YOUR_VERCEL_PROJECT_DOMAIN]/[METHOD]?username=[YOUR_LINKEDIN_USERNAME]" />

Methods

URL	Example	Description
`/experience`	`[YOUR_DOMAIN]/experience?username=[YOUR_LINKEDIN_USERNAME]`	Your LinkedIn experience section.
`/education`	`[YOUR_DOMAIN]/education?username=[YOUR_LINKEDIN_USERNAME]`	Your LinkedIn education section.
`/skills`	`[YOUR_DOMAIN]/skills?username=[YOUR_LINKEDIN_USERNAME]`	Your LinkedIn skills section.
`/languages`	`[YOUR_DOMAIN]/languages?username=[YOUR_LINKEDIN_USERNAME]`	Your LinkedIn languages section.
`/user`	`[YOUR_DOMAIN]/user?username=[YOUR_LINKEDIN_USERNAME]`	Your Fullname, Headline and Location.

Parameters

Name	Example	Description	Required
username	?username=[YOUR_LINKEDIN_USERNAME]	Your LinkedIn username.	YES
limit	?username=[YOUR_LINKEDIN_USERNAME]&limit=10	Count of the lists items.	NO

Deploy your own

You can deploy and use this project without any errors on your own Vercel instance by the following steps:

Guide on setting up Vercel 🔨

Go to vercel.com
Click on Login
Sign in with GitHub by pressing Continue with GitHub
Sign into GitHub and allow access to all repositories, if prompted
Fork this repo
Go back to your Vercel dashboard
Select Import Project
Select Import a Git Repository
Select root and keep everything as is, just place your LinkedIn cookie called li_at as your environment variable named LINKEDIN_TOKEN and click Deploy
You're good to go. See your domains to use the API!

Technologies

github-readme-linkedin's People

Contributors

Stargazers

Watchers

Forkers

jmbarbone raed-ra b-uday-chandra-001 josenilto vikas2004 jobyid jhennifercardozo mogueno ssoroushhh arnavraii raj-dsml heipry parthmodi152 brichards30 phuccuongngo99 mario263 friendbear swamikalagiri bharathulaprasad kyleswillard itika1 sunilgudivada achingachris kim5981 domingosliraneto lidianelimaocn joseantonioalves guildedthorn kockataepich darlontenorio thakurinbox ipuppyyt essodillon sk112 venkatvenky97 jether2011 nagibs nigr0mante adithya1010 ikwemogena noeliabentancor iamhrayr brichavez syrineb11 gabrielfernandes251 iamsahilphadtare innovia prarthnaluthra zo-bro-23 mackenr snrankin coderutk fykaa tushar-c23 jaywong666 mihirrajdixit planetmalone justinyoo drakkola shodown96 srummanf brunolubiandnca reginald231 theprinceraj janboro hayes28 ismailnguyen ifedayoprince cavinhthuan vilinh27 thatph riyaagrawalrocks dhruvjsx rawankhattab

github-readme-linkedin's Issues

Image is rendered but the content is missing

First of all, really nice work!

I may have found a bug.
I set up my own instance on Vercel and included the code in my readme as follows:

<p>
    <img src="https://github-readme-linkedin-ebon.vercel.app/experience?username=joel-maximilian-mai" />
</p>
<p>
    <img src="https://github-readme-linkedin-ebon.vercel.app/education?username=joel-maximilian-mai" />
</p>

But as you can see, the text in the image is rendered, but there is no content shown.
Method experience