Git Product home page Git Product logo

github-pages-'s Introduction

License People Stars Forks Watches Last Updated

Showcase All Your Projects ๐Ÿ›๏ธ๐ŸŽ‡

projects screenshot
projects screenshot

Introducing Projects

Present all your projects in style with a super customizable web app! โœจ

Projects uses the GitHub API to list all your GitHub projects in a nice searchable grid. Also shows pretty programming icons using devicons.

Inspiration

Needed a way to display all my projects, used my portfolio's project section as inspiration.

Getting Projects

To get projects, follow these steps:

git clone https://github.com/Ms-Shahid/Ms-Shahid
cd projects

Setup Your Own Projects

You can easily set up projects to show your own repos.

  • Fork the repo
  • Clone it
  • Open up script.js and update the username variable to your GitHub username.
  • Open up index.html and update the title tag to make it your username.
  • You may also want to update the favicon too, update the link tag in index.html
  • Push your changes
  • Go to repo settings on GitHub and enable GitHub Pages.

The site should be live on https://<your-username>.github.io/projects

Here's the projects page for @sindresorhus

sindresorhus's projects

Number Of Repos

The number of repos is controlled by the maxPages variable, the GitHub API supports 100 repos per page max. If you have less than 100 repos, set maxPages to 1, if you have 300 then 3.

You can also edit the fetch query to reduce the per page repo count.

There's no pagination, all repos are shown on the same page.

Authenticated Requests

If you are working locally and notice the API is not sending over data, it might be because of rate limit on GitHub API requests.

You can either wait for an hour or setup a personal access token on GitHub and pass that into the fetch request in script.js

Programming Language Icons

This project uses Devicon for adding language icons, if the language name and icon are not being displayed correctly for any of your repos, update devicons mapping in script.js.

Viewing projects

Open index.html in your favorite browser or visit https://ms-shahid.github.io/Ms-Shahid/.

How it was built

Projects was built using HTML CSS & JavaScript. It was built on Neovim and the python http server. Uses GitHub API for data and Devicons for programming icons.

What I learned

  • Learned about a few quirks of the fetch API, especially implementation of maxPages.
  • Flex, box-shadow and some other CSS tricks were revisited.

What's next

You tell me!

Hit the โญ button if you found this useful.

More Info

github-pages-'s People

Contributors

ms-shahid avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.