Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rishavanand/github-profilinator

๐Ÿš€ This tool contains mini GUI components that you can hook together to automatically generate markdown code for a perfect readme.
https://github.com/rishavanand/github-profilinator

gatsby generator github hacktoberfest markdown profile react readme

Last synced: 29 days ago
JSON representation

๐Ÿš€ This tool contains mini GUI components that you can hook together to automatically generate markdown code for a perfect readme.

Awesome Lists containing this project

README

        

# Github Profilinator

Generate creative GitHub profile readmes in few click!




View Generator ยท View Generated Profile ยท Report Bug ยท Request Feature

_Loved the project? Show your love to the developer by starring this repo._


---

This project is aimed to simplify your GitHub profile generation process by providing creative components from all over the web which can be added in a few click. In the end, with the click of a button, markdown is auto-generated which you can directly add to your readmes.

---

## ๐Ÿง Feature list

- [x] Image and text fields have multiple options like alignment, sizes, fit to screen
- [x] Skill set filed
- [x] Social badges field
- [x] GitHub activity and language stats
- [x] Dynamic blog posts
- [x] Visitor counter
- [x] Init with demo template
- [x] Multi column support
- [x] Customizable blocks and layouts
- [x] Listening to from Spotify
- [x] Multi template
- [ ] Last tweet from Twitter
- [ ] Last 3 uploads from Instagram

## ๐Ÿš€ Getting started

This project is already deployed on https://profilinator.rishav.dev

Instructions for local deployment are given below:

1. Clone the repository

```
git clone [email protected]:rishavanand/github-profilinator.git
```

2. Enter the project directory

```
cd github-profilinator
```

3. Install dependencies

```
npm i
```

4. Start local dev server

```
npm start
```

5. View local deployment at [http://127.0.0.1:8000](http://127.0.0.1:8000)

## ๐Ÿ’ซ Built on the shoulders of giants

- [amazing github-readme-stats](https://github.com/anuraghazra/github-readme-stats) by Anurag Hazra for creating detailed statistics
- [github-profile-views-counter](https://github.com/antonkomarev/github-profile-views-counter) by Anton Komarev for simplifying visitor counter
- [blog post workflow](https://github.com/gautamkrishnar/blog-post-workflow) by Gautam Krishna R which is a Genius use of Github Actions.
- [spotify-github-profile](https://github.com/kittinan/spotify-github-profile) by Kittinan which generated Spotify's currently listening album cover image.

NOTE : All the logos/icons belong to their respective owners , we don't own them.

## :heart: Supporting the project

A simple star to this project repo is enough to keep me motivated on this project for days. If you find your self very much excited with this project let me know with a tweet.

Thanks!

Contributions are welcomed!