/react-github-repo-cards

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

Primary LanguageJavaScript

React Github Repo Cards

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

UI

licence GitHub package.json version GitHub repo size Twitter URL

🛠️ Built with

Installation

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

  1. Clone the repo to your machine

    git clone https://github.com/sabesansathananthan/react-github-repo-cards.git
    cd react-github-repo-cards
  2. Install packages

    If you use npm

    npm install

    or

    If you use yarn

    yarn
  3. Change username

    Open GitHub.js in the api folder. Use your github user name👤 instead of sabesansathananthan.

    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

    npm start

    or

    If you use yarn

    yarn start
  6. Visit http://localhost:3000

Deploy with Vercel

Don't forget to give a star ⭐ for this repo 🙂

Article Related Article

Embed your GitHub project on your React website - Sabesan Sathananthan

📄 License

This project is licensed under the MIT License - see the LICENSE file for details