Skip to content

Latest commit

 

History

History
94 lines (63 loc) · 2.62 KB

README.md

File metadata and controls

94 lines (63 loc) · 2.62 KB
Raw

/me

github-me

The easiest way to create your GitHub profile page for free!

About /me

✅ All your profile information will be accessed through the public GitHub API.

✅ So if you are the profile filled, everything will work 🎒

✅ You don't need to have infrastructure costs the availability will be made by gh-pages free of charge. 🤑

✅ You will have a link to share on your social networks with SEO's meta tags. will also be indexed by the google search engine. 🚀

✅ Profile information is done in the project build.

✅ The list of projects is dynamically updated using jquery on the client side.

Features

  • Show basic profile (login, name and bio)
  • Show company, location, blog and twitter
  • List organizations
  • Number of followers
  • Count of public repos
  • Account created at
  • List of repos with the tag
  • Progressive Web App (PWA)
  • SEO's meta tags
  • Deploy using gh-pages
  • Responsive for mobile
  • Dark/light mode
  • Friendly customization

How to create your profile page?

Just fork this project to your GitHub.

Follow the steps:

  1. Create a fork
  2. Enable GitHub Actions
  3. Run pipeline deploy to GitHub Pages
  4. Access your profile page: https://<username>.github.io/me

See how to deploy to step by step details.

How show the repositories?

To show GitHub repository on profile page add me tag to repo.

The project catalog component dynamically runs on client side using jquery.

GitHub API

The endpoint used are:

Running localhost

Clone repository

git clone [email protected]:rafaelbmateus/me.git
cd me

Building the page using python3:

GITHUB_USERNAME=<username> python3 builder/main.py

Open the index.html file.

Others profile pages builders

If you want something more powerful take a look at the projects:

it will probably take you more than 1 minute to deploy.