https://github.com/gastonpereyra/cards-service

For create Cards as SVG-Images to use in the Github Profile
https://github.com/gastonpereyra/cards-service

javascript node profile serverless service vercel

Last synced: 2 months ago
JSON representation

For create Cards as SVG-Images to use in the Github Profile

• Host: GitHub
• URL: https://github.com/gastonpereyra/cards-service
• Owner: gastonpereyra
• License: mit
• Created: 2021-09-19T18:22:33.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2021-10-31T18:15:30.000Z (over 4 years ago)
• Last Synced: 2025-05-22T11:33:20.206Z (about 1 year ago)
• Topics: javascript, node, profile, serverless, service, vercel
• Language: JavaScript
• Homepage: https://rgp-cards-service.vercel.app
• Size: 550 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Profile Cards Service :credit_card:

![Profile Cards Banner](https://user-images.githubusercontent.com/39351850/133937678-28adceb4-db43-419e-8e3f-cd087b1209bf.png)

## Description :feather:

For create Cards as SVG-Images to use in the Github Profile

## Wiki :book:

In the Wiki of this project, there is more Details about APIs and its uses, it is in Spanish.

➕ [INFO :es:](https://github.com/gastonpereyra/cards-service/wiki)

## API :telephone_receiver:

* Base URL: `rgp-cards-service.vercel.app`

### User :bust_in_silhouette:

#### Stats 📈

* 🔗 `/api/user/{username}`

![imagen](https://user-images.githubusercontent.com/39351850/137608185-882b5406-5fc3-4f67-9202-4bc4a87043b3.png)

* Path Paramenters 🆔

    * `username`: _string_

* Query Parameters ❔

    * `width` : _number_ 

    * `lineHeigth`: _number_ 

    * `hideTitle` : _true | false_

    * `hideBorders`: _true | false_

    * `hideYear`: _true | false_

    * `hide` : _stars | commits | issues | prs | contributions_ 

    * `showIcons`: _true | false_

    * `includeAlCommits`: _true | false_

    * `theme` : _dark | light | error_

    * `iconColor` : _string_

    * `titleColor` : _string_

    * `textColor` : _string_

    * `backgroundColor` : _string_

#### Language Ranking 🔝

* 🔗 `/api/user/{username}/languages`

![imagen](https://user-images.githubusercontent.com/39351850/137608459-03625272-33dc-4231-a9aa-930c4c4ea02d.png)

* Path Paramenters 🆔

    * `username`: _string_

* Query Parameters ❔

    * `width` : _number_

    * `lineHeigth`: _number_

    * `hideTitle` : _true | false_

    * `hideBorders`: _true | false_

    * `hide` : _string_

    * `isCompact`: _true | false_

    * `theme` : _dark | light | error_

    * `iconColor` : _string_

    * `titleColor` : _string_

    * `textColor` : _string_

    * `backgroundColor` : _string_

#### Repositories 📍

* 🔗 `/api/user/{username}/repository/{repositoryName}`

![imagen](https://user-images.githubusercontent.com/39351850/137608451-775c09ec-e9eb-47c9-9714-0085c166d839.png)

* Path Paramenters 🆔

    * `username`: _string_

    * `repositoryName`: _string_

* Query Parameters ❔

    * `width` : _number_

    * `lineHeigth`: _number_

    * `hideTitle` : _true | false_

    * `hideBorders`: _true | false_

    * `showOwner`: _true | false_

    * `theme` : _dark | light | error_

    * `iconColor` : _string_

    * `titleColor` : _string_

    * `textColor` : _string_

    * `backgroundColor` : _string_

### Organization :busts_in_silhouette:

#### Stats 📈

* 🔗 `/api/organization/{username}`

![imagen](https://user-images.githubusercontent.com/39351850/137646524-e8266dec-8b52-448f-891e-71cfc1e79d75.png)

* Path Paramenters 🆔

    * `username`: _string_

* Query Parameters ❔

    * `width` : _number_ 

    * `lineHeigth`: _number_ 

    * `hideTitle` : _true | false_

    * `hideBorders`: _true | false_

    * `hideYear`: _true | false_

    * `hide` : _stars | members | teams | projects | packages | repositories_ 

    * `showIcons`: _true | false_

    * `includeAlCommits`: _true | false_

    * `theme` : _dark | light | error_

    * `iconColor` : _string_

    * `titleColor` : _string_

    * `textColor` : _string_

    * `backgroundColor` : _string_

#### Language Ranking 🔝

* 🔗 `/api/organization/{username}/languages`

![imagen](https://user-images.githubusercontent.com/39351850/137647202-d777103a-3cb2-4b1a-84de-9a50a4d0e594.png)

* Path Paramenters 🆔

    * `username`: _string_

* Query Parameters ❔

    * `width` : _number_

    * `lineHeigth`: _number_

    * `hideTitle` : _true | false_

    * `hideBorders`: _true | false_

    * `hide` : _string_

    * `isCompact`: _true | false_

    * `theme` : _dark | light | error_

    * `iconColor` : _string_

    * `titleColor` : _string_

    * `textColor` : _string_

    * `backgroundColor` : _string_

#### Repositories 📍

* 🔗 `/api/organization/{username}/repository/{repositoryName}`

![imagen](https://user-images.githubusercontent.com/39351850/137608686-00c22be8-f0b8-4b65-b15f-2fd0ee40d9f5.png)

* Path Paramenters 🆔

    * `username`: _string_

    * `repositoryName`: _string_

* Query Parameters ❔

    * `width` : _number_

    * `lineHeigth`: _number_

    * `hideTitle` : _true | false_

    * `hideBorders`: _true | false_

    * `showOwner`: _true | false_

    * `theme` : _dark | light | error_

    * `iconColor` : _string_

    * `titleColor` : _string_

    * `textColor` : _string_

    * `backgroundColor` : _string_

## Found any Bug :bug: ?

[Report Here](https://github.com/gastonpereyra/cards-service/issues/new?assignees=gastonpereyra&labels=bug&template=bug.md&title=[BUG])

## Have an Idea :bulb: ?

[Tell me](https://github.com/gastonpereyra/cards-service/issues/new?assignees=gastonpereyra&labels=enhancement&title=%5BIDEA%5D+-)

## Credits

This project is inspire in one of [anuraghazra](https://github.com/anuraghazra):

[![github-readme-stats](https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats&theme=buefy)](https://github.com/anuraghazra/github-readme-stats#wakatime-week-stats)

Please support original project!

* ➖ [Differences](https://github.com/gastonpereyra/cards-service/wiki#-diferencias)