Giter VIP home page Giter VIP logo

rahulbanerjee26 / githubprofilereadmegenerator Goto Github PK

View Code? Open in Web Editor NEW
205.0 6.0 52.0 68.04 MB

Generate a cool README/About me page for your Github Profile

Home Page: https://rahulbanerjee26-githubprofilereadmegenerator---init---0nsops.streamlitapp.com/

License: MIT License

Python 100.00%
github-readme github-readme-profile github-readme-generator github-aboutme streamlit streamlit-webapp hacktoberfest hacktoberfest2021

githubprofilereadmegenerator's Introduction

GitHub Profile README / About Me Generator ๐Ÿ’ฏ

forthebadge made-with-python Github Profile README Generator - A Few inputs+ ~15mins= Github Profile reaches a new level ๐Ÿ”ฅ | Product Hunt Streamlit-Badge

This web app lets you build a cool README for your profile.

Screencast of Github AboutMe/Profile ReadMe Generator

A few inputs + ~15 mins = Your GitHub Profile reaches a new level ๐Ÿ”ฅ

Live ๐ŸŒž

Go to - Live Site

Article ๐Ÿ“

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 ๐Ÿงฐ

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.
  2. Create a virtual environment
    python -m venv venv
  3. Activate the virtual environment
    # Windows 
    venv/Scripts/activate
    
    # Linux/macOS
    source venv/bin/activate
  4. Install required dependencies
    pip install -r requirements.txt
  5. Run the App
    streamlit run __init__.py

Contributors โœจ

Contributing ๐Ÿค

Feature Suggestion and Problems ๐Ÿ’Ž

Go to 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
  2. Clone it using the URL from the Code button.
    git clone FORK_URL
  3. Create your Feature Branch
    git checkout -b feat-my-feature
  4. Commit your Changes
    git commit -m 'Add some Amazing Feature'
  5. Push to the Branch
    git push origin feat-my-feature
  6. Go to Pull Requests of the original repo.
  7. 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:

- <a href = 'https://github.com/USERNAME'> DISPLAY NAME </a>

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 ๐ŸŒ 

License โš–๏ธ

  • Distributed under the MIT License. See LICENSE for more information.

Resources

githubprofilereadmegenerator's People

Contributors

brandonbartram98 avatar elsowiny avatar fethan-el-fadl avatar goz4el avatar guyeternal avatar michaelcurrin avatar muhammed-rajab avatar rahulbanerjee26 avatar salikansari6 avatar saminul avatar soumya-kushwaha avatar yogeshwaran01 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

githubprofilereadmegenerator's Issues

add more svg icons.

I have found that some of my social media icons not there to show in profile i.e dev.to and more

Visitor count stopped working

The visitor count stopped working and gets an Invalid upstream response (429) error. It seems to be flaky. Might need to replace the badge altogether or try to determine the root cause for the flakiness.

Documentation

Make the live site efficient by improving the language

Remove Section If No Input

It would be cool to make it so the sections that arent filled in are automatically removed from the markdown when generating to save the user having to delete it themselves.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.