Github user repo card

Table of content

• About
• How to install
• Usage
• Example
• License

About

This card is generating react component in order to show Github user and repository informations. In current version 0.6.xyou are able to set user's name, repository name, type of card width and height of the GitHub card as seen above on the image.

How to install

In order to install run following command:

$ npm i github-user-repo-card

Usage

For now it is only possible to import like module, it will not work with Commonjs.

import { GithubCard } from "github-user-repo-card";

In the render method use <GithubCard> and defined by type you will generate for user or repository. Code example for user profile card:

<GithubCard name="basskibo" type="user" repository="blogtech_dev" width={300} height={400} />

Code example for repository card:

 <GithubCard name="basskibo" type="repo" repository="github-user-repo-card" width={500} height={150} />

Example

You can check Live Example

Available properties

| Name | Description | Implemented | | :---: | :--- | :---: | | type | Type can be user/profile or repository| ✅ | | name | Account name of user/profile on the GitHub | ✅ | | repository | Name of the repository on the GitHub | ✅ | | useCache | Flag boolean wheather to used cache data. Default false | ❌ | | width | Set desired width of the GitHubCard | ✅ | | height | Set desired height of the GitHubCard | ✅ | | showProperties | Set desired array of properties which you want to show | ❌ | | clickable | boolean flag wheather card will be link or static. Default true| ❌ |

License

See LICENSE for full details.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.