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://github-cards.onrender.com

Embed one of these in your README:

<!-- Markdown -->

![Card](https://github-cards.onrender.com/any_card_name)

OR

<!-- HTML -->
<img src="https://github-cards.onrender.com/any_card_name" alt="Card" />

List of card names currently available

Available Cards Example Available Params Preview
jokes-card ![Card](https://github-cards.onrender.com/jokes-card?theme=dark) theme=all_themes https://github-cards.onrender.com/jokes-card?theme=dark
programming-quotes-card ![Card](https://github-cards.onrender.com/programming-quotes-card) theme=all_themes https://github-cards.onrender.com/programming-quotes-card
motivational-quotes-card ![Card](https://github-cards.onrender.com/motivational-quotes-card) theme=all_themes https://github-cards.onrender.com/motivational-quotes-card
word-of-the-day-card ![Card](https://github-cards.onrender.com/word-of-the-day-card) theme=all_themes https://github-cards.onrender.com/word-of-the-day-card
challenge-of-the-week-card ![Card](https://github-cards.onrender.com/challenge-of-the-week-card) theme=all_themes https://github-cards.onrender.com/challenge-of-the-week-card
team-work-quote-card ![Card](https://github-cards.onrender.com/team-work-quote-card) theme=all_themes https://github-cards.onrender.com/team-work-quote-card
random-card ![Card](https://github-cards.onrender.com/random-card) theme=all_themes https://github-cards.onrender.com/random-card

Available Themes List

  1. light
  2. dark
  3. dark_2
  4. pattern_1
  5. pattern_2
  6. pattern_3
  7. random - Any random theme will we applied
  8. 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

  • Pattern_1 Theme Card
    Card

  • Pattern_2 Theme Card
    Card

  • Pattern_3 Theme Card
    Card

For More Visit

https://github-cards.onrender.com/

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.
  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.

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 muskansa1n1 avatar rohitroy-github avatar sidhant-sriv avatar

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.