https://github.com/sabesansathananthan/react-github-repo-cards

User can show the GitHub repository cards in their react wesite. Card component is created using Material-UI
https://github.com/sabesansathananthan/react-github-repo-cards

cards github material-ui react repository

Last synced: about 2 months ago
JSON representation

User can show the GitHub repository cards in their react wesite. Card component is created using Material-UI

• Host: GitHub
• URL: https://github.com/sabesansathananthan/react-github-repo-cards
• Owner: sabesansathananthan
• Created: 2020-10-02T19:16:57.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-08T19:16:33.000Z (almost 4 years ago)
• Last Synced: 2024-04-10T00:57:50.192Z (5 months ago)
• Topics: cards, github, material-ui, react, repository
• Language: JavaScript
• Homepage: https://react-github-repo-cards.vercel.app/
• Size: 505 KB
• Stars: 21
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Code of conduct: docs/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-material-ui - React Github Repo Cards - Extended Material-UI Card component to show the GitHub repositories. (Components)

README

        
React Github Repo Cards




This application aims to show the Github repositories of the user in his/her react website.









      

    

      

    

      

    

      

    



## 🛠️ Built with

- [React JS](https://reactjs.org/) - Front-End JavaScript library

- [Material UI](https://material-ui.com/) - React UI Framework

## Installation

To setup the app for development on your local machine, please follow the instructions below:

1.  Clone the repo to your machine

    ```bash

    git clone https://github.com/sabesansathananthan/react-github-repo-cards.git

    cd react-github-repo-cards

    ```

2.  Install packages

    If you use `npm`

    ```bash

    npm install

    ```

    or

    If you use `yarn`

    ```bash

    yarn

    ```

3.  Change username

    Open [GitHub.js](./src/api/GitHub.js) in the api folder. Use your github user name👤 instead of sabesansathananthan.

    ```JavaScript

    const USER_NAME = 'sabesansathananthan';

    ```

4.  Add Token

    Create a new .env file in your root folder. Add your github personal access tokens in `.env`

    ```

    REACT_APP_API_KEY = YOUR_PERSONAL_ACCESS_TOKEN

    ```

5.  Run the development server

    If you use `npm`

    ```bash

    npm start

    ```

    or

    If you use `yarn`

    ```bash

    yarn start

    ```

6.  Visit 

## [Live Demo](https://react-github-repo-cards.vercel.app/)

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/git/external?repository-url=https://github.com/sabesansathananthan/react-github-repo-cards)

Don't forget to give a star :star: for this repo :slightly_smiling_face:

##  Related Article

[Embed your GitHub project on your React website](https://medium.com/design-bootcamp/embed-your-github-project-on-your-react-website-ccefacc30f62) - _Sabesan Sathananthan_

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](./.github/LICENSE) file for details