⚙ How to use Github corner

⚙ How to use Github corner

What is it

Github corner is an npm package that allows you to include in your main website page a Github logo in a corner with a custom link and a nice animation on hover.

Why I use it

The first time I saw something similar was on a react-Pokedex I found on Github. The live application had on the left side a ribbon linked to the issue section of the git repo and on the right side a ribbon linked to the code section of the git repo.

I found this very useful for developers who want to go to the code repo in one click. But also very light to not pollute the interface.

See how it looks integrated into my projects

How to use it

  1. Install the module with npm
    npm install --save react-github-corner
    
  2. Import it in your main app component
    import GithubCorner from 'react-github-corner';
    
  3. Render the component
    <GithubCorner href="https://github.com/username/repo" />
    

Useful links

Conclusion

I think this kind of small link into your side project is always very good to have without surcharging the footer or header with non-related links. I can now share only my live project URL instead of sharing live and code URL everywhere.