https://github.com/rahuldkjain/github-profile-readme-generator
๐ Generate GitHub profile README easily with the latest add-ons like visitors count, GitHub stats, etc using minimal UI.
https://github.com/rahuldkjain/github-profile-readme-generator
gatsby generator github hacktoberfest markdown react readme
Last synced: 7 months ago
JSON representation
๐ Generate GitHub profile README easily with the latest add-ons like visitors count, GitHub stats, etc using minimal UI.
- Host: GitHub
- URL: https://github.com/rahuldkjain/github-profile-readme-generator
- Owner: rahuldkjain
- License: apache-2.0
- Created: 2020-07-15T11:20:48.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-16T00:31:23.000Z (over 1 year ago)
- Last Synced: 2025-05-07T21:15:52.488Z (7 months ago)
- Topics: gatsby, generator, github, hacktoberfest, markdown, react, readme
- Language: JavaScript
- Homepage: https://rahuldkjain.github.io/gh-profile-readme-generator
- Size: 14.3 MB
- Stars: 22,746
- Watchers: 92
- Forks: 7,559
- Open Issues: 377
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- Awesome-GithubProfile-README - github-profile-readme-generator
- fucking-awesome-github-profile-readme - Github Profile README Generator - This tool provides an easy way to create github profile readme with latest addons like `visitors count`, `github stats` etc. (Tools)
- awesome-rainmana - rahuldkjain/github-profile-readme-generator - ๐ Generate GitHub profile README easily with the latest add-ons like visitors count, GitHub stats, etc using minimal UI. (TypeScript)
- awesome-github-profile-readme - Github Profile README Generator - This tool provides an easy way to create github profile readme with latest addons like `visitors count`, `github stats` etc. (Tools)
- awesome-starts - rahuldkjain/github-profile-readme-generator - ๐ Generate GitHub profile README easily with the latest add-ons like visitors count, GitHub stats, etc using minimal UI. (JavaScript)
- StarryDivineSky - rahuldkjain/github-profile-readme-generator
- awesome-github-readme-tools - gh-profile-readme - CLI tool for README generation (CLI Tools / Dynamic Badges)
- awesome-readme-tools - rahuldkjain/GitHub Profile Readme Generator - ๐ Generate github profile readme easily with the latest add-ons like visitors count, github stats, etc using minimal UI. (Readme Generator)
- awesome-ccamel - rahuldkjain/github-profile-readme-generator - ๐ Generate GitHub profile README easily with the latest add-ons like visitors count, GitHub stats, etc using minimal UI. (TypeScript)
- awesome-list - github-profile-readme-generator - ons like visitors count, GitHub stats, etc using minimal UI. | rahuldkjain | 6473 | (JavaScript)
- jimsghstars - rahuldkjain/github-profile-readme-generator - ๐ Generate GitHub profile README easily with the latest add-ons like visitors count, GitHub stats, etc using minimal UI. (JavaScript)
- awesome-ubc-profile-readme - Github Profile README Generator - This tool provides an easy way to create github profile readme with latest addons like `visitors count`, `github stats` etc. (Tools)
- awesome-bd-readme-profile - Github Profile README Generator - This tool provides an easy way to create github profile readme with latest addons like `visitors count`, `github stats` etc. (Tools / Images Gifs:)
- awesome-starz - rahuldkjain/github-profile-readme-generator - ๐ Generate GitHub profile README easily with the latest add-ons like visitors count, GitHub stats, etc using minimal UI. (TypeScript)
- awesome-arsenal - github-profile-readme-generator - ็ๆ GitHub ่ช่ฟฐๆไปถใ (็งๆๅ ฌๅธ / GitHub)
- awesome-github-profile - Github Profile README Generator - This tool provides an easy way to create github profile readme with latest addons like `visitors count`, `github stats` etc. (Tools)
- AwesomeGithubProfileTemplates - Github Profile README Generator - This tool provides an easy way to create github profile readme with latest addons like `visitors count`, `github stats` etc. (Resources / Tools)
README
GitHub Profile README Generator
View Demo
ยท
Report Bug
ยท
Request Feature
Loved the tool? Please consider donating ๐ธ to help it improve!
#### Tired of editing GitHub Profile README with new features?
This tool provides an easy way to create a GitHub profile readme with the latest add-ons such as `visitors count`, `github stats`, etc.
## ๐ Demo
Try the tool: [GitHub Profile README Generator](https://rahuldkjain.github.io/gh-profile-readme-generator)
## ๐ง Features
Just fill in the details such as `Name`, `Tagline`, `Dev Platforms Username`, `Current Work`, `Portfolio`, `Blog`, etc. with a minimal UI.
- **Uniform Dev Icons**
- **Uniform Social Icons**
- **Visitors Counter Badge**
- **GitHub Profile Stats Card**
- **GitHub Top Skills**
- **GitHub Streak Stats**
- **Dynamic Dev(.)to Blogs** (GitHub Action)
- **Dynamic Medium Blogs** (GitHub Action)
- **Dynamic Personal Blogs from RSS Feed** (GitHub Action)
- **Wakatime Stats** [contribute](https://github.com/rahuldkjain/github-profile-readme-generator/issues/115)
- **Buy Me A Coffee button**
Click on `Generate README` to get your README in `markdown`.
You can preview the README too.
## ๐ ๏ธ Installation Steps
1. Clone the repository
```bash
git clone https://github.com/rahuldkjain/github-profile-readme-generator.git
```
2. Change the working directory
```bash
cd github-profile-readme-generator
```
3. Install dependencies
```bash
npm install
```
4. Run the app
```bash
npm start
```
๐ You are all set!
## ๐ฐ Contributing
Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/rahuldkjain/github-profile-readme-generator/compare).
Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.
## ๐ป Built with
- [Gatsby](https://www.gatsbyjs.com/)
- [Tailwind CSS](https://tailwindcss.com/): for styling
- [GSAP](https://greensock.com/gsap/): for small SVG Animations
## ๐ Special Thanks
- [Anurag Hazra](https://github.com/anuraghazra) for amazing [github-readme-stats](https://github.com/anuraghazra/github-readme-stats)
- [Anton Komarev](https://github.com/antonkomarev) for super cool [github-profile-views-counter](https://github.com/antonkomarev/github-profile-views-counter)
- [Gautam Krishna R](https://github.com/gautamkrishnar) for the awesome [blog post workflow](https://github.com/gautamkrishnar/blog-post-workflow)
- [Jonah Lawrence](https://github.com/DenverCoder1) for the incredible [github-readme-streak-stats](https://github.com/DenverCoder1/github-readme-streak-stats)
- [Julien Monty](https://github.com/konpa) for super useful [devicon](https://github.com/konpa/devicon)
- [Eliot Sanford](https://github.com/techieeliot) for adding hashnode as a blog input
## ๐ Sponsors
- [Scott C Wilson](https://github.com/scottcwilson) donated the first-ever grant to this tool. A big thanks to him.
- [Max Schmitt](https://github.com/mxschmitt) loved the tool and showed support with his donation. Thanks a lot.
- [Aadit Kamat](https://github.com/aaditkamat) find the tool useful and showed support with his donation. A big thanks to him.
- [Jean-Michel Fayard](https://github.com/jmfayard) used the generator to create his GitHub Profile README and he loved it. Thanks to him for showing support to the tool with the donation.
## ๐ Support
Developed with โค๏ธ in India ๐ฎ๐ณ