Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rahulbanerjee26/githubprofilereadmegenerator
Generate a cool README/About me page for your Github Profile
https://github.com/rahulbanerjee26/githubprofilereadmegenerator
github-aboutme github-readme github-readme-generator github-readme-profile hacktoberfest hacktoberfest2021 streamlit streamlit-webapp
Last synced: 7 days ago
JSON representation
Generate a cool README/About me page for your Github Profile
- Host: GitHub
- URL: https://github.com/rahulbanerjee26/githubprofilereadmegenerator
- Owner: rahulbanerjee26
- License: mit
- Created: 2021-02-27T05:34:05.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-22T13:10:08.000Z (about 2 years ago)
- Last Synced: 2025-01-22T12:08:54.035Z (7 days ago)
- Topics: github-aboutme, github-readme, github-readme-generator, github-readme-profile, hacktoberfest, hacktoberfest2021, streamlit, streamlit-webapp
- Language: Python
- Homepage: https://rahulbanerjee26-githubprofilereadmegenerator---init---0nsops.streamlitapp.com/
- Size: 66.4 MB
- Stars: 217
- Watchers: 6
- Forks: 52
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Profile README / About Me Generator 💯
[](https://www.python.org/)
[](https://rahulbanerjee26-githubprofilereadmegenerator---init---0nsops.streamlitapp.com/ "Go to web app")
## This web app lets you build a cool README for your profile.
## A few inputs + ~15 mins = Your GitHub Profile reaches a new level 🔥
## Live 🌞
[](https://rahulbanerjee26-githubprofilereadmegenerator---init---0nsops.streamlitapp.com/)
## Article 📝
- [How to create a GitHub Profile README using this web app](https://www.realpythonproject.com/a-free-tool-to-take-your-github-profile-to-the-next-level/) on RealPythonProjet.
The article contains resources for GIFs, royalty free images/icons and tutorials on how to create your secret repo for the About Me Page, setting up the blog flow action etc.
## Usage 🔧
- Fill in the text boxes. Leave the ones you do not wish to fill blank.
- By default the generated ReadMe has GitHub stats and Wakatime stats, feel free to remove them.
- If you want to build on top of the Readme, refer to the article I mentioned above for resources and tips
- If you used this app to build your README, consider adding yourself to the "Users who used this app to generate a README" section. You can showcase your README and others will be able to view it and star it. You are guaranteed a star from me ⭐
## Built With 🧰
- [Python](https://github.com/python)
- [Streamlit](https://github.com/streamlit)
## Features 💿
- GIFs
- Social Icons
- Skill Icons
- Visitors Badge
- Github Stats
- WakaTime Stats
- .yml file to display Blog Posts from your feed
- Ability to add image banners at beginning of README
- Random Jokes Card
### Update 05-01-2020 🗓
- Clicking on Skills shows your github repos filtered on that skill
- Chose GitHub Stats Card Type
- Cool Image in About Me section
- Fixed styling
- Added Default Content
### Update 07-05-2022 🗓
- Fixed Some Gif Issues
- Added Banner Images Sugesstions
- Updated Streamlit beta elements
## Running Locally 🖥️
1. Clone the repo or your fork.
1. Create a virtual environment
```sh
python -m venv venv
```
1. Activate the virtual environment
```sh
# Windows
venv/Scripts/activate
# Linux/macOS
source venv/bin/activate
```
1. Install required dependencies
```sh
pip install -r requirements.txt
```
1. Run the App
```sh
streamlit run __init__.py
```
## Contributors ✨
- Rahul Banerjee - [@rahulbanerjee26](https://github.com/rahulbanerjee26)
- Michael Currin - [@MichaelCurrin](https://github.com/MichaelCurrin)
## Contributing 🤝
### Feature Suggestion and Problems 💎
Go to [Issues](https://github.com/rahulbanerjee26/githubProfileReadmeGenerator/issues) on the repo.
- Create an explaining the Feature.
- If you find any errors/issues, feel free to create an Issue.
### Pull Requests 🔀
How to make code changes and add them to this repo with a Pull Request.
1. Fork the Project
1. Clone it using the URL from the Code button.
```sh
git clone FORK_URL
```
1. Create your Feature Branch
```sh
git checkout -b feat-my-feature
```
1. Commit your Changes
```sh
git commit -m 'Add some Amazing Feature'
```
1. Push to the Branch
```sh
git push origin feat-my-feature
```
1. Go to [Pull Requests](https://github.com/rahulbanerjee26/githubProfileReadmeGenerator/pulls) of the original repo.
1. Create a Pull Request. Compare across forks and pick your fork and your branch.
Once your PR is merged, I will add you as a contributor :)
Or if you wish to add yourself to 'Users who used this app' list, simply fork the repo, update the README and make a PR. Follow this format:
```markdown
- DISPLAY NAME
```
Or just reach out to me on Twitter/LinkedIn and I'll add you :)
To keep your fork's main branch up to date with that of the original repo, then on your fork on GitHub click the Fetch Upstream button near the top.
## Plans for future release 📆
- Adding more badges
- Giving user ability to chose between different ReadMe designs
- Increasing number of social Icons
## Users who used this app to generate a README 🌠
- Rahul Banerjee
- Saminul Islam
- Sourav Kr. Saikia
- Brandon Bartram
- Miguel Gozaine
## License ⚖️
- Distributed under the `MIT License`. See [LICENSE](/LICENSE) for more information.
## Resources
- https://metrics.lecoq.io/