Create your GitHub profile page in 1 minute without 1 line of code for free
Tags: opensource, github, webdev, python
Published: 2022-08-07 18:34:00

[GitHub-me](https://github.com/rafaelbmateus/me) is the easiest way to create your profile page from
[GiHub](https://github.com) for free. 😎

All your profile information will be accessed through the public
[GitHub API](https://docs.github.com/en/rest). 🎒

So, have your [GitHub registration](https://github.com/settings/profile) properly filled out.
That way you don't need to make any code changes. 🤖

You don't need to have infrastructure costs the availability will be made by
[gh-pages](https://docs.github.com/en/pages/getting-started-with-github-pages/creating-a-github-pages-site) 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. 🚀

## Features

- ✅ Show basic profile (login, name and bio)
- ✅ Show company, location, blog and twitter
- ✅ 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

## How to create your profile page?

To create your own profile follow the steps below.
Basically, just fork [me](https://github.com/rafaelbmateus/me) project to your github.

Follow the steps:

1. [Create a fork](https://github.com/rafaelbmateus/me/fork)
2. Enable Github Actions
3. Run deploy to Pages
4. Access your profile page in `https://<username>.github.io/me`

### Details of the steps

#### 1. Create a fork

To create a fork of this project access
https://github.com/rafaelbmateus/me/fork
and click in "Create fork" button.

![1-create-fork](https://user-images.githubusercontent.com/8009492/183292845-e8f86d3e-c596-4212-9924-44298df7d063.png)

#### 2. Enable Github Actions

By default actions are not automatically enabled for forks.
Select Actions in your repository forked and click in
"I understand my workflows, go ahead and enable them".

![2-enable-actions](https://user-images.githubusercontent.com/8009492/183292858-e7c7d341-b2b4-4b12-8f70-11347ccc1820.png)

#### 3. Run deploy to Pages

Select "Deploy static content to Pages" Workflow,
click in "Run workflow", use workflow from Branch: main
and click in "Run workflow".

![3-run-deploy](https://user-images.githubusercontent.com/8009492/183292862-88981f49-1f68-420c-88f2-d11f57f340e4.png)

Check if deploy static content to Pages workflow
run completed successfully.

![4-check-deploy](https://user-images.githubusercontent.com/8009492/183292869-b9a0c403-7988-4d1c-aab1-d80d055bbbf2.png)

#### 4. Access your profile page

Access your profile page
in `https://<username>.github.io/me/`.

> Change `<username>` with your github user. Like: https://github.com/rafaelbmateus
  the username is `rafaelbmateus`.

![5-preview](https://user-images.githubusercontent.com/8009492/183292874-39411ce2-db4f-413a-be17-ba13913cee2b.png)

## How show the repositories?

The repositories you want to appear in your profile page's project catalog put the `me` tag.

You can change the tag to another one you prefer
but you will need to change a line of code
[assets/js/github.js#L6](https://github.com/rafaelbmateus/me/blob/main/assets/js/github.js#L6).

## GitHub API

The HTML fields are filled using data from github.

The endpoint used are:

- [api.github.com/users/:user](https://api.github.com/users/rafaelbmateus)
- [api.github.com/users/:user/repos](https://api.github.com/users/rafaelbmateus/repos)

## Running localhost

Clone repository

```console
git clone git@github.com:rafaelbmateus/me.git
cd me
```

Build the page using:

```console
GITHUB_USERNAME=<username> python3 builder/main.py
```

## Others profile pages builders

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

- [Docusaurus](https://docusaurus.io)
- [Hugo](https://gohugo.io)
- [Jekyll](https://jekyllrb.com)
- [Gatsby](https://www.gatsbyjs.com)
- [DeveloperFolio](https://github.com/saadpasta/developerFolio)

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