Giter Club home page Giter Club logo

github-cards-api's Introduction

Github-Cards-Api

How to use

Visit endpoint url for all available cards and available options for each card
Endpoint URL: https://afraid-ninnetta-github-cards.koyeb.app

Embed one of these in your README:

<!-- Markdown -->

![Card](https://afraid-ninnetta-github-cards.koyeb.app/any_card_name)

OR

<!-- HTML -->
<img src="https://afraid-ninnetta-github-cards.koyeb.app/any_card_name" alt="Card" />

List of card names currently available

Available Cards Example Preview
jokes-card ![Card](https://afraid-ninnetta-github-cards.koyeb.app/jokes-card?theme=dark) Card
programming-quotes-card ![Card](https://afraid-ninnetta-github-cards.koyeb.app/programming-quotes-card) Card
motivational-quotes-card ![Card](https://afraid-ninnetta-github-cards.koyeb.app/motivational-quotes-card) Card
word-of-the-day-card ![Card](https://afraid-ninnetta-github-cards.koyeb.app/word-of-the-day-card) Card
challenge-of-the-week-card ![Card](https://afraid-ninnetta-github-cards.koyeb.app/challenge-of-the-week-card) Card
team-work-quote-card ![Card](https://afraid-ninnetta-github-cards.koyeb.app/team-work-quote-card) Card
bhagavad-geeta-card ![Card](https://afraid-ninnetta-github-cards.koyeb.app/bhagavad-geeta-card) Card
random-card ![Card](https://afraid-ninnetta-github-cards.koyeb.app/random-card) Card
programming-facts-card ![Card](https://afraid-ninnetta-github-cards.koyeb.app/programming-facts-card?theme=dark) Card

Available Themes List

  1. light
  2. dark
  3. dark_2
  4. rgb
  5. lemonade
  6. pattern_1
  7. pattern_2
  8. pattern_3
  9. random - Any random theme will we applied
  10. custom - You can set your custom arguments

Custom Theme Arguments

args: {
    card_color: "Card color. Default: #ffffff  [Optional]",
    font_color: "Card text color. Default: #000000  [Optional]",
    bg_color: "Card Background color. Default: #fff  [Optional]",
    shadow: "Card shadow. Default: false  [Optional]",
    shadow_color: "Card shadow color. Default: #000000  [Optional]",
},

Themes Example

  • Light Theme Card
    Card

  • Dark Theme Card
    Card

  • Dark_2 Theme Card
    Card

  • Rgb Theme Card
    Card

  • Lemonade Theme Card
    Card

  • Pattern_1 Theme Card
    Card

  • Pattern_2 Theme Card
    Card

  • Pattern_3 Theme Card
    Card

For More Visit

https://afraid-ninnetta-github-cards.koyeb.app/

How to contribute

Add new card

  1. Fork this repository.
  2. Add your card in src/cards directory, you can take the refrence from already added cards.
  3. Add any data file inside data directory that your card will use. (Languages Support: Hindi & English)
  4. Add route of your card in index.js file.
  5. Add your card api refrence inside in src/help.js file and also in README.md file.
  6. Create pull request.
  7. Note: Data file must have arounf 100 entries minimum.

Add new theme

  1. Fork this repository.
  2. If you want to add gradient background then add your gradient code in src/gradients.js file.

    Take refrence from already added gradients.

  3. Add your theme name in the src/themes.js file.

    Theme name should be unique and should be in the second last position of the array.

  4. Create your theme in src/themes.js file.

    Take refrence from already added themes.

  5. Add your theme api refrence inside in src/help.js file and also in README.md file.

github-cards-api's People

Contributors

akanshsirohi avatar anniebhalla10 avatar dependabot[bot] avatar kmnat avatar mahitej28 avatar muskansa1n1 avatar piyushkdas0611 avatar rohitroy-github avatar sidhant-sriv avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

github-cards-api's Issues

Adding Programming facts Card

I would like to contribute to this project under Hacktoberfest by adding a programming facts card. Kindly assign me this issue

New theme

I would like to add a new theme for the cards

thought : can I do word of the day card ?

Sample data :
{
"index": 0,
"word": "abate",
"meaning": "to become less intense or widespread"
},
{
"index": 1,
"word": "acerbic",
"meaning": "sharp and forthright in speech or manner"
},
{
"index": 2,
"word": "benevolent",
"meaning": "well-meaning and kindly"
},
{
"index": 3,
"word": "candor",
"meaning": "the quality of being open and honest"
},
{
"index": 4,
"word": "deleterious",
"meaning": "causing harm or damage"
},
{
"index": 5,
"word": "ephemeral",
"meaning": "lasting for a very short time"
},

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.