Giter VIP home page Giter VIP logo

shravan20 / github-readme-quotes Goto Github PK

View Code? Open in Web Editor NEW
248.0 11.0 128.0 11.06 MB

Dynamic quote generator for your GitHub readmes | Give a poetic touch to readmes

Home Page: https://github-readme-quotes-returns.vercel.app/

License: MIT License

JavaScript 97.84% HTML 0.93% CSS 1.13% Shell 0.10%
readme-md quote-generator profile-readme readme-generator hacktoberfest express nodejs node node-js reactjs

github-readme-quotes's Introduction

logo

Github Readme Quotes: Dynamic quote generator for your GitHub readmes

banner

alt PRs Welcome Open Source? Yes! GitHub contributors Pull Request Counts last commit deployment-status Build Status



Current status

  • Project Status: Migrated to Vercel Cloud

  • Project Deployment Status: I have moved it from Heroku to Vercel Cloud now. Please access the content from UI on https://github-readme-quotes-returns.vercel.app and utility on https://github-readme-quotes-bay.vercel.app/quote

  • Self-Hosting and Contributions: If you wish to host the project on your own, you can fork the repository and deploy it according to your needs. Feel free to reach out to me if you require any assistance or have inquiries about the project. Your contributions and involvement in the project are welcome.


Shoutout to Vercel

Big shoutout to Vercel for their amazing hosting service! @vercel

Featuring on Dynamic GitHub Profile Readme Quotes - Everlasting Poetic Touch to GitHub Profiles for everyone | Product Hunt

Buy Me a Coffee at ko-fi.com

Inspired by @anuraghazra



Use User Interface, to view designed quotes and copy link and paste it directly


Features

Sl No Feature Name Description
1 Dynamic Quotes Different quotes every time its rendered for GitHub Profile Readme
2 Colorful Themes Various colorful themes available for cards
3 Design Layouts Different Layout design cards are available
4 Animation Animations available for quote cards
5 Custom Quotes from GitHub Gists You can add custom quotes of your own or own choice from GitHub Gists json files
6 Quotes based on Category Different category based quotes are available

Note: To read an article on this project, please refer: GitHub Profile README : Animated Dynamic Quote Generator


Github Readme Quotes

Copy and paste the following markdown content to display the quote.

![Quote](https://github-readme-quotes-bay.vercel.app/quote)



  • Themes

You can display your quote in different themes without any manual customization.

Use ?theme=THEME_NAME parameter as shown below.

![Quote](https://github-readme-quotes-bay.vercel.app/quote?theme=dark)

Available Themes

dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula

Dark

Quote

Light Theme

Quote

You can explore different themes here.

Feel free to contribute different themes.


  • Layouts

You can also change the layout of your templates.

Use ?layout=LAYOUT parameter as shown below

![Quote](https://github-readme-quotes-bay.vercel.app/quote?theme=dark&layout=socrates)

Layout 1 (Default)

Quote

Layout 2 (Socrates)

Quote

You can explore different layouts here.

Feel free to contribute different layouts.


  • Fonts

You can also add fonts to your templates.

Use ?font=FONT_NAME parameter as shown below

![Quote](https://github-readme-quotes-bay.vercel.app/quote?font=Redressed)

Font 1 (Default)

Quote

Font 2 (Redressed)

Quote

You can explore different fonts here.

Feel free to contribute different fonts.


  • Animations

You can also add animations to your templates.

Use ?animation=ANIMATION paramater as shown below

![Quote](https://github-readme-quotes-bay.vercel.app/quote?theme=dark&animation=grow_out_in)

Animation 1

Quote

You can explore different animations here.


  • Custom Quotes

You can also provide a file with the list of quotes and a random quote will be generated for you.

Follow the steps to provide your own custom quotes

  • Use the template provided at here and write your own file with multiple quotes.

  • Save the file in the repository in any (public) directory or anywhere in the internet.

  • Get the link of the file.

  • Use ?quotesUrl=URL as shown below

    
    
    ![Quote](https://github-readme-quotes-bay.vercel.app/quote?quotesUrl=https://github.com/ShubhKotnala/github-readme-quotes/blob/custom-quotes/customQuotes/quotes.json)
    

Quote


  • Category based Quotes

You can also provide a category to fetch the list of quotes based on certain category and a random quote will be generated for you based on category you specify.

Available Categories

general life success motivational
fun programming dream failure
gaming birthday Humorous Travel
  • Use quoteCategory=categoryName as shown below

    
    
     ![Quote](https://github-readme-quotes-bay.vercel.app/quote?quoteCategory=motivational)
    

Quote

Feel free to contribute different quotes to different categories.

Follow the steps to add quotes to category

  • Add the quote you want in this file based on the category it falls into.
  • If the category you want doesn't exist, feel free to add the category in this file and add the quotes.

Swagger Docs

To view Swagger docs, run npm start and open localhost:3002/api-docs.


Huge Shoutout to all the Star-Gazers
Stargazers repo roster for @shravan20/github-readme-quotes

Huge Shoutout to all the Forkers
Forkers repo roster for @shravan20/github-readme-quotes

github-readme-quotes's People

Contributors

adhiraj-12 avatar adidem23 avatar afrizalyogi avatar ahmadswalih avatar albatrosspreacher avatar amitesh03 avatar bokub avatar borguuh avatar dependabot[bot] avatar dev-keshav avatar fathomer avatar hafiz-muhammad avatar hendrasob avatar hijal avatar hsin75c avatar iqrazareef-1024 avatar isengu avatar leotran20 avatar lordpansar avatar nabaisu avatar natapg avatar nishantpersonal avatar rededge967 avatar shravan20 avatar shubhankarnineleaps avatar shubhkotnala avatar tincho4t avatar veerbhadrasolanki avatar version0chiro avatar wasp0094 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  avatar  avatar  avatar  avatar  avatar

github-readme-quotes's Issues

Theme Not Found

Describe the bug
Returns an error message when unknown theme was added on to query strings

To Reproduce
Steps to reproduce the behavior:

  1. Go to Browser
  2. Click on 'http://localhost:3000/quote?theme=merko1'
  3. See error

Expected behavior
Should return default theme card, if undefined theme is sent

[Feature Request] Custom Fonts to the quotes

Is your feature request related to a problem? Please describe.
We are not able to set the custom font to the quotes rendered on the card. We can add another query params to add custom fonts for the quotes

Describe the solution you'd like
Taking in a fonts as query-params and setting that font in the css, otherwise setting default font for the quote.

Enhancement: Center quotes

The src content seems to not be symmetrical; consequently, it (quotes card) cannot be centered, even when offset w/ custom height and width.

This problem (centering) can only be fixed by fixing the src content (to be symmetrical)--especially since either align="left" and align="right" seem so unfitting.

Cheers!

bug: UI Dashboard drop down issue

Description:

This issue relates to template selection in the quote card. In the UI, the themes selected are not getting reflected since recent feature to add color background and font color is overriding the actual defined templates

image

Looping in @GRenziITDM for better context & review

Alignment of Zues template in Front-End

There is a certain unalignment and nonuniform size with the last template in the other layouts. This only occurs for Zues layout which makes it look a bit uneven.

Steps:

  1. Open The front end website on full screen desktop and scroll down.
  2. Use the react developer tool to check the size of template cards.

System Specification:

  • Windows 10
  • Monitor size: 1920x1080
  • Browser Used: Brave

Screenshots:
image

Quote not fully visible

Bug
The quote template is being trimmed out and is not fully visible in the readme.

Screenshots
Screenshot from 2020-11-18 11-30-57

Creation and implementation of SwaggerDocs

Is your feature request related to a problem? Please describe.
Implementation of SwaggerDocs for maintaining developer's reference documentation.

Describe the solution you'd like
Use swagger-ui-express and swagger-jsdoc
For detailed implementation plan, refer this article

The page is not working and the renders are not loading on the profile

Describe the bug
The server is down perhaps as nothing is being returned from the link and the page is also not working.
To Reproduce
Open the official website for the application or try to see your own GitHub quotes card

Screenshots
If applicable, add screenshots to help explain your problem.

image

Layout appearance getting changed in the github dark mode

Describe the bug
When switched to the dark mode in github,the layout appearance are getting changed.

To Reproduce
Steps to reproduce the behavior:

  1. Switch to the dark mode in github.
  2. Go to the layouts section to view the layouts.

Expected behavior
Layouts are not appearing as they did before.

Screenshots
Screenshot from 2020-12-09 11-50-17

Gradient Design Background for the Quote Card

Is your feature request related to a problem? Please describe.
Implementation for the Github-Readme-Quotes for the Card

Describe the solution you'd like
Alternative background solution instead of current SOLID COLOUR option, where user passes gradient name, and corresponding quote background.

[BUG] Inconsistent SVG size

Describe the bug
The svg image returned from the server is of a static size 700x300 which makes it difficult to align properly with the content since the extra space is filled with transparent background, which makes that space unusable.

To Reproduce
Steps to reproduce the behavior:

  1. Generate any quote with any layout.
  2. Check the size of the image, and the actual content size of the image.

Expected behavior
svg size is expected to be the same as the necessary content.

Screenshots
image

Quotes based on Specific Personality

Is your feature request related to a problem? Please describe.
Create Quotes taken from your favourite personality

Describe the solution you'd like

  • You can use existing API that provides this functionality

Describe alternatives you've considered
Create a folder, storing JSON file storing all personalities quotes in natural order (Aplhabetical order)

[Feature Request] Unit Testing Rendering Functions

Is your feature request related to a problem? Please describe.
We have cross checked the working. Still, want an Unit Testing of UI components rendered to ensure the working.

Describe the solution you'd like
A proper unit testing of the functions that responsible for rendering svg component using Jest Library.

Describe alternatives you've considered
Have used Mocha for testing. But as you know, Mocha cannot test components rendering and stuff, we removed it in the initial release of v0.9. If you want to propose alternatives for Jest, please feel free to comment on the same.

[Feature Request] Custom Quotes

Problem Statement
I'm excited by the fact that I would be able to add dynamic quotes to my GitHub read-me page, but these quotes would be always random. The quotes that would be generated by a specific category or from a list of quotes would be highly useful as that would meet the requirement to clearly give dynamic quotes based on my profile, ex: Designer, Developer, etc.

Possible Solution
A file in the GitHub profile repository that contains a list of data that would be used to get the quotes data from, so that always predictable, but random quotes appear on the read-me.

Additional context
Let's say I have a read-me page and I want to have random quotes but from a certain set of quotes. I would make a file from a template and enter the quotes, then I would get the quotes to my read-me page from this file. In this way I'm sure what my profile viewers would see.

feat: Create a leaderboards for custom themes/quotes/other bits for users

Feature Description:

Organize quote-writing challenges and display leaderboards to encourage friendly competition within the user community.

The "Create Leaderboards for Custom Themes/Quotes/Other Bits" feature enhances user engagement and recognition by allowing users to create and customize leaderboards based on various criteria such as themes, quotes, or any other creative elements. This feature aims to showcase and celebrate the creativity of the community in a personalized and organized manner.

Dark Theme for the website

Is your feature request related to a problem? Please describe.
Implementation of the Dark Theme for the React Website for Github Readme Quotes, to get a view of how the card looks in the Dark theme of the Github API

[Feature Request] Missing Docs about using Custom Font

Is your feature request related to a problem? Please describe.

Basically in the main ./README.md file, we have not mentioned/added any docs about how to use URL feed for custom font

Describe the solution you'd like

Simply add about the font docs to the README.md with an example snapshot

Additional context

Add all the images/snaps in the assets folder.

Heroku hosting is not working

Hey developer, your https://github-readme-quotes.herokuapp.com/quote is not working since Heroku has stopped its all free services, I request to change the hosting platform.

Screenshot 2022-12-17 at 1 46 50 PM

Suggested platforms are:

Simple Thank You Collaborators Card on the UI

Is your feature request related to a problem? Please describe.
Implementation of simple div card, thanking the contributors

Describe the solution you'd like
A simple card to applauding the contributors for their contribution as a part of the Github-Readme-Quotes Website itself.

Feel free to propose any new alternative.

[Feature Request] Documentation as part of React Application

Is your feature request related to a problem? Please describe.
User Interface, where all the information as a part of Repo to be included in the screen

Describe the solution you'd like
Implementing Screen in the React App, which includes,

Describe alternatives you've considered
Use the existing markdown, to be part of the React UI itself, using React Markdown Previewer

chore: move all promises syntactic to async/await

Task

Refactor the codebase to utilize async/await syntax instead of promises for improved readability and maintainability.

Details

Currently, the codebase extensively uses promises for asynchronous operations. Converting these to utilize async/await syntax will enhance the codebase in the following ways:

  • Readability: Async/await syntax provides a more intuitive and synchronous-like flow, making the code easier to read and understand.
  • Error Handling: async/await allows for more natural error handling using try/catch blocks, improving error traceability.
  • Simplified Logic: Converting promise chains to async functions simplifies the control flow and reduces the need for nested .then() calls.

Steps to Accomplish

  • Identify all occurrences of promise-based syntax in the codebase.
  • Replace these with appropriate async/await usage.
  • Ensure that error handling is appropriately adjusted using try/catch blocks.
  • Thoroughly test the refactored code to ensure functionality and performance are maintained.

Additional Information

  • Ensure to maintain code functionality and avoid introducing regressions during the refactoring process.
  • Pay attention to error handling and propagate errors appropriately.
  • Consider documenting the changes made and update relevant documentation if needed.

feat: Quote of the day Widget Feature

Is your feature request related to a problem? Please describe.
Currently we support feature to generate dynamic quotes, but not static quotes

Describe the solution you'd like
This feature would allow to provide static quotes on daily basis. This quote for a profile would change on per day basis.

[Feature Request] Category For Quotes

Is your feature request related to a problem? Please describe.
The quotes generated are random and the user has no clue on the kind of quote which is going to be displayed

Describe the solution you'd like
An option for users to select the category of the quotes which they want to display.

Regarding Categories for Quotes

Description

Could you list all the available fields/categories -- which could be input specifically for random quotes to display.

Thank you!

Path for anyone wondering: ./customQuotes

Create custom themes from Website itself

Is your feature request related to a problem? Please describe.
Every time a theme is to be added, we have to raise a PR and add them from the code.

Describe the solution you'd like
A platform raising allowing to add the custom themes and accordingly update the code files using github actions

Describe alternatives you've considered
Any other alternative solutions are accepted

Dynamic url generation

Describe the bug
Dynamic url generation in the dashboard is wrong since after the migration this has not been updated to GCP url, hence need to fix this to be dynamic as per current host rather than hardcoding it

feat: GitHub README Template Generator

Description of feature:

This is a custom template generator by specifically select colors for each of the components of the Github Readme Quotes like:

  • Readme Card
  • Border Color
  • Font Color
  • Font Border color

feat: Emoji Integration into the quotes

Is your feature request related to a problem? Please describe.
Currently, no support for emojis

Describe the solution you'd like
Provide support for emojis in the github readme quotes on the card.

[Feature Request] Language Translation for Quotes

Is your feature request related to a problem? Please describe.
Since currently we have a feature for generating quotes, we do not have an option to preview the quote in native language of our choice. Hence, proposing a feature that allows us to convert the quote into native language of our choice.

Describe the solution you'd like
Pending

Describe alternatives you've considered

  • Using some NPM packages to convert the retrieved quote into native language
  • Using Google Translator API to convert into native language of our choice

Refinement ContributorCard

Describe the bug

  • Address React warning (screenshot) by including a unique key prop in the Avatar component during mapping to ensure proper rendering and avoid potential issues.
  • Remove border property in the root class definition as it was invalid ('10px');
  • Implement error handling for the fetch request to handle potential network (fault tolerance).
  • Renaming property of avatar component from MarginLeft to marginLeft (it was invalid).

[Preview Quotes and Generate URL]

Is your feature request related to a problem? Please describe.
Create User Interface to preview different possible template combinations and get the generated URL for the same.

Describe the solution you'd like
Pending

Add Responsiveness in Navbar

In the mobile view, "Make your own personalized style for the Quotes" is hidden, and the navbar UI is suboptimal.

The font size of "Github Dynamic Quotes for Readme" should be reduced, and it should be displayed row-wise.

Additionally, the dark mode theme icon is not displaying correctly in the mobile view.

Furthermore, the Product Hunt image should be resized to a smaller dimension for a better mobile viewing experience.

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.