Project me is the easiest way to create your profile page from GiHub for free. π
All your profile information will be accessed through the public GitHub API. π
So, have your GitHub registration 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 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 project to your github.
Follow the steps:
- Create a fork
- Enable Github Actions
- Run deploy to Pages
- 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.
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".
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".
Check if deploy static content to Pages workflow run completed successfully.
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 israfaelbmateus
.
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.
GitHub API
The HTML fields are filled using data from GitHub.
The endpoint used are:
Running localhost
Clone repository
git clone git@github.com:rafaelbmateus/me.git
cd me
Build the page using:
GITHUB_USERNAME=<username> python3 builder/main.py
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.
Top comments (0)