Home

Awesome

<div align="center"> <h1>Cardivo card name</h1> <p>Get your card name dynamically 😎</p>

License: MIT Issue Forks Stars

</div>

Description

A few months ago, GitHub launched a new feature call Magic Readme which is that file readme will be appear in your GitHub profile and you can set your skills, portfolio, etc in that file readme.

Cardivo is a serverless dynamically card name based on SVG (Scalable Vector Graphics) which is you can make your own card name and set in your magic readme. For the tech stack, Cardivo using Typescript and serverless function from Vercel and also this project had been deployed on Vercel.

How to use this?

It's simple, you can copy paste this markdown content, like this one:

![Satya Wikananda's card name](https://cardivo.vercel.app/api?name=[name]&description=[description]&image=[image_url])

There are several options you can use, and the options is:

OptionsDescriptionTypeExampleQuery Params
NameMandatory Your nameStringSatya Wikananda?name=[value]
DescriptionMandatory Some text about youStringI am a coder?description=[value]
ImageMandatory An avatar image of youURLhttps://example.com/image.jpg?image=[value]
Background ColorBackground color for the card nameHex color code%23ffffff?backgroundColor=[value]
Icon ColorColorize the icons in card nameHex color code%23e64a19?iconColor=[value]
Font ColorFont color for the card nameHex color code%23000000?fontColor=[value]
SiteIf you have a site, you can fill this oneStringhttps://satyawikananda.tech?site=[value]
PatternYou can use a pattern for the background. You can see the list belowStringplus?pattern=[value]
Color PatternFill the color patternHex color code%231abc9c?colorPattern=[value]
Opacity PatternOpacity of the pattern backgroundFloat0 - 1?opacity=[value]
InstagramYour Instagram usernameStringsatyawikananda?instagram=[value]
LinkedinYour Linkedin usernameStringSatya Wikananda?linkedin=[value]
GitHubYour GitHub usernameStringsatyawikananda?github=[value]
TwitterYour Twitter usernameStringsatya_wikananda?twitter=[value]
Disable AnimationDisable animation transitionBooleantrue?disableAnimation=[value]

NB: Remove the square bracket

Pattern in Cardivo, i'm used the Hero Pattern package which is developed by Lowmess, and here the list:

PatternValue
Plusplus
Topographytopography
Texturetexture
Hideouthideout
FallingTrianglesfallingTriangles
I Like FoodiLikeFood
Four point starsfourPointStars
Brick wallbrickWall
Wigglewiggle
Bubblesbubbles
Floating CogsfloatingCogs
Leafleaf
Rainrain
Polkadotspolkadots
Tic Tac ToeticTacToe

Example

This is example of using cardivo:

Markdown content:

![Satya wikananda's card name](https://cardivo.vercel.app/api?name=Satya%20Wikananda&description=Hi,%20i%27m%20a%20front%20end%20web%20developer%20and%20i%27m%2020%20y.o.%20Nice%20to%20meet%20you%20%F0%9F%91%8B&image=https://avatars.githubusercontent.com/u/33148052?v=4&backgroundColor=%23ecf0f1&instagram=satyawikananda&linkedin=I%20Gusti%20Ngurah%20Satya%20%20Wikananda&github=satyawikananda&twitter=satya_wikananda&pattern=leaf&colorPattern=%23eaeaea)

Result:

Satya wikananda's card name

Contribution

Want to make this project better? You can contribute this project, I am very open if there are contributions to this project.


forthebadge forthebadge

Powered by Typescript and vercel. Code licensed under MIT License.