https://github.com/mamal72/react-github

:octocat: A set of useful Github components for React
https://github.com/mamal72/react-github

github github-api react react-component

Last synced: about 2 months ago
JSON representation

:octocat: A set of useful Github components for React

• Host: GitHub
• URL: https://github.com/mamal72/react-github
• Owner: mamal72
• License: mit
• Created: 2015-10-09T11:52:00.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-06-12T19:17:07.000Z (over 8 years ago)
• Last Synced: 2024-10-28T10:52:42.811Z (about 2 months ago)
• Topics: github, github-api, react, react-component
• Language: JavaScript
• Homepage:
• Size: 469 KB
• Stars: 34
• Watchers: 4
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/mamal72/react-github.svg?branch=master)](https://travis-ci.org/mamal72/react-github)

[![npm version](https://badge.fury.io/js/react-github.svg)](https://badge.fury.io/js/react-github)

# react-github

**react-github** is a set of react components for Github written by ES6 and ES7. It's a WIP and more components will be added.

# Installation

You can install this package via `npm`:

```bash

npm install react-github --save

```

# Components

## GithubProfile

Renders a simple Github user profile box with some useful info about the user.



    



```js

import React, { Component } from 'react';

import { GithubProfile } from 'react-github';

class Test extends Component {

  render() {

    return (

      


        

      

    );

  }

}

```


### Properties

* **username**: Github username

* **className**: custom-additional CSS class for root element of rendered component

## GithubRepository

Renders a repository info box with some details of it.



    



```js

import React, { Component } from 'react';

import { GithubRepository } from 'react-github';

class Test extends Component {

  render() {

    return (

      


        

        

        

        

        

      

    );

  }

}

```


### Properties

* **username**: Github username

* **repository**: Github repository name

* **showName** (default: *true*): render repository name

* **showUsername** (default: *true*): render username

* **showDescription** (default: *true*): render repository description

* **className**: custom-additional CSS class for root element of rendered component

# Ideas?

Just fill an issue and describe it. I'll check it ASAP. :)

# Contribution

You can fork the repository and send the pull requests.

Remember to lint your code before sending pull requests. Run the following command and fix the errors if you get any.

```bash

npm run lint

```