🎨 Beautify your github profile with this amazing tool, creating the readme your way in a simple and fast way 🚀 The best profile readme generator you will find ⚡

Overview

Profile Readme Generator

The best profile readme generator you will find!

Badge showing the total of project forks Badge showing the total of project stars Badge showing average commit frequency per month Badge showing when the last commit was made Badge showing the total of project issues Badge showing the total of project pull-requests Badge showing project license type

About   |   Technologies   |   Requirements   |   Starting   |   Contributing

🎯 About

Tired of editing your github profile? Looking for some cool readme to do a ctrl+c ctrl+v? Or are you tired of missing out on the amazing features you can add to your readme? What about configuring github actions? 😩 Come on!

Beautify your github profile with this amazing tool, creating the readme your way in a simple and fast way! Include what you want, place it wherever you want, however you want! (But of course, respecting the limits of what is possible to do in markdown 😁 )

Loved the tool? Please consider donating 💸 to help it improve!

profile-readme-generator.mp4

🚀 Main Technologies

Next Logo     Typescript Logo     Styled Components Logo     Jest Logo     Eslint Logo     Prettier Logo

See more

Requirements

Before starting 🏁 , you need to have Git and Node installed (nvm recommended).

🏁 Starting

# Clone this project
$ git clone https://github.com/maurodesouza/profile-readme-generator

# Access
$ cd profile-readme-generator

# Install dependencies
$ yarn

# Run the project
$ yarn dev

# The server will initialize in the <http://localhost:3000>

🎮 Scripts

  • dev: starts the application at localhost:3000
  • build: creates an optimized production build of application
  • start: starts the application in production mode at localhost:3000 (have run the build before)
  • test: run the tests
  • lint: run eslint in /src

📝 License

This project is under license from MIT. For more details, see the LICENSE file.

Made with ❤️ by Mauro de Souza

 

Back to top

Readme created with Simple Readme

Comments
  • Fix character case in headline

    Fix character case in headline

    What type of PR is this? (check all applicable)

    • [ ] Refactor
    • [ ] Feature
    • [x] Bug Fix
    • [ ] Enhancement
    • [ ] Documentation Update

    What I did

    • Fix small typo in how the word "I' was being used
    opened by CassioLeodegario 3
  • Fix: spelling mistake

    Fix: spelling mistake

    Fixing a small spelling for the word "I"

    Close #4

    What type of PR is this? (check all applicable)

    • [ ] Refactor
    • [ ] Feature
    • [x] Bug Fix
    • [ ] Enhancement
    • [ ] Documentation Update

    What I did

    • Fix character case for the word "I" in the template file
    opened by CassioLeodegario 2
  • Fixed typo

    Fixed typo

    What type of PR is this? (check all applicable)

    • [ ] Enhancement
    • [ ] Refactor
    • [ . ] Bug Fix
    • [ ] Feature
    • [ ] Documentation Update

    What I did

    Changed "i'm" to "I'm" in src/resources/templates.ts

    Fixes issue #4

    opened by lolzone13 2
  • FEAT: Adding a confirmation modal to improve UX

    FEAT: Adding a confirmation modal to improve UX

    Problem:

    When I was using the application, I clicked on the delete icon and deleted everything I had created.

    Solution:

    With the user experience in mind, I implemented a confirmation modal that ensures that no one will be able to accidentally delete the README.

    I kept the application design in the modal to ensure a good UI.

    image

    Code pattern

    Also, I kept the code pattern used by you, Mauro.

    Hope you enjoyed and approve this PR. Thanks!

    opened by barretogustavo 2
  • Change

    Change "Direita" to "Right" in align fields

    What type of PR is this? (check all applicable)

    • [ ] Refactor
    • [ ] Feature
    • [X] Bug Fix
    • [ ] Enhancement
    • [ ] Documentation Update

    What I did

    Match align fields translation for activities, music and profile-views with the rest of application.

    opened by guedesvf 2
  • 🐛  fix: django tech icons

    🐛 fix: django tech icons

    What type of PR is this? (check all applicable)

    • [ ] Refactor
    • [ ] Feature
    • [x] Bug Fix
    • [ ] Enhancement
    • [ ] Documentation Update

    What I did

    Fixed Django logo path and its variants

    Closes #9

    opened by maurodesouza 1
  • [BUG]: There is a bug with logo on the web application.

    [BUG]: There is a bug with logo on the web application.

    What happens?

    When you're scrolling bunch of skills to choose, logo of Django does not display properly. So users can see only alternative text. The same issue is, when you try to choose variant of Django logo.

    What are the steps to reproduce this issue?

    1. open website
    2. Scroll to find Django logo.

    What were you expecting to happen?

    I expected to see proper Django logo instead of alt text.

    Additional information about your environment

    • Device: [laptop]
    • OS: [Linux Manjaro]
    • Browser: [chrome]

    Additional context

    No response

    bug 
    opened by alexbud1 1
  • [BUG]: Small typo in the headline template

    [BUG]: Small typo in the headline template

    What happens?

    When creating a new readme using the template 2 the readline comes with an small incorrect character case Hi 👋! My name is ... and i'm a ..., from .... when it should be Hi 👋! My name is ... and I'm a ..., from ....

    What are the steps to reproduce this issue?

    1 - Create a new Readme 2 - Select template 2 3 - Edit the headline text

    What were you expecting to happen?

    It should show Hi 👋! My name is ... and I'm a ..., from ....

    Additional information about your environment

    • Device: Desktop
    • OS: Windows
    • Browser: Brave
    • Version: V1.39.122

    Additional context

    No response

    bug good first issue 
    opened by CassioLeodegario 1
  • Fix untranslated text in align fields

    Fix untranslated text in align fields

    What type of PR is this? (check all applicable)

    • [ ] Refactor
    • [ ] Feature
    • [X] Bug Fix
    • [ ] Enhancement
    • [ ] Documentation Update

    What I did

    Match align fields translation for activities, music and profile-views with the rest of the application.

    opened by guedesvf 1
  • [BUG]: Application error: a client-side exception has occurred (see the browser console for more information).

    [BUG]: Application error: a client-side exception has occurred (see the browser console for more information).

    What happens?

    Every attempt to right click an element(from the preview) generate this exception.

    Here's a console log:

    TypeError: e is undefined NextJS 9 framework-5f4595e5518b5600.js:1:82741 TypeError: e is undefined NextJS 9 main-1a59f16f14cc63cc.js:1:8788 A client-side exception has occurred, see here for more info: https://nextjs.org/docs/messages/client-side-exception-occurred main-1a59f16f14cc63cc.js:1:8805 NextJS 23

    What are the steps to reproduce this issue?

    Open the website, right click an element from the preview.

    What were you expecting to happen?

    A cascade menu with an option to deletion such component.

    Additional information about your environment

    • Device: [e.g. iphoneX, desktop] Desktop
    • OS: [e.g. ios, windows] Windows 10
    • Browser: [e.g. opera, chrome] Firefox
    • Version: [e.g. 22] 101.0.1

    Additional context

    No response

    bug 
    opened by joaovpimenta 0
Owner
Mauro de Souza
Front End Developer
Mauro de Souza
A simple JavaScript beautify tool

A simple JavaScript beautify tool This tool will do the following things: Beautify the JavaScript code Convert hexadecimal number to decimal number, s

phithon 27 May 8, 2022
This site compares your GitHub Profile to your friends, and analyses and tells your GitHub profile score too.

GitHub ⚔️ Duel Deployed at ?? : https://githubduel.vercel.app/ Compare your GitHub profiles with your friends It gives score to GitHub profile based o

Anshuman swain 17 Nov 21, 2022
A simple editor allows you to easily add and customize all the sections you need for your profile's readme.

Create your Profile README using the best Templates tomper-readmify.herokuapp.com This is the frontend + backend of TomperReadmify build with MERN sta

Varun Tiwari 15 Jan 2, 2023
Welcome contributers❤️🎉. Just add your name, Github profile link and Linkedin link🔗 Look at Readme for more.📖

Hello Welcome Developers! Step - 1 Create a GitHub account, if you don't already have one. Step - 2 Register for Hacktoberfest: Navigate to the Hackto

Prineth Fernando 28 Oct 31, 2022
GPRM : GitHub Profile ReadMe Maker

?? Best Profile Generator, Create your perfect GitHub Profile ReadMe in the best possible way. Lots of features and tools included, all for free ! ??

Vishwa Gaurav 338 Jan 3, 2023
Open source app to beautify screenshots, quickly and easily

Codename: Pika What it does Lets you quickly beautify screenshots by adding rounded corners, background colors, shadows and more. You can copy the bea

Rishi Mohan 458 Dec 29, 2022
An IoT bottle that tracks water consumption. Winner of Best Health Hack, MLH's Best Hardware Hack, and QB3's Best Big Data for the Improvement of Health Care Winner at CruzHacks 2022.

An IoT bottle that tracks water consumption. Winner of Best Health Hack, MLH's Best Hardware Hack, and QB3's Best Big Data for the Improvement of Health Care Winner at CruzHacks 2022.

Nathanael Garza 2 Jan 21, 2022
Create a new challenge for jshero.platzi.com, share your experience creating amazing challenges.

JSHero - jshero.platzi.com ?? Create a new challenge for jshero.platzi.com, share your experience creating amazing challenges. Create a new challenge:

Comunidad Platzi 28 Oct 19, 2022
Create a new challenge for jshero.platzi.com, share your experience creating amazing challenges.

JSHero - jshero.platzi.com ?? Create a new challenge for jshero.platzi.com, share your experience creating amazing challenges. Create a new challenge:

PlatziLabs 20 Apr 27, 2022
MagicSniffer is a amazing tool could help you decrypt GI traffic by MAGIC of WindSeedClientNotify

MagicSniffer We have posted an article about this on sdl.moe: 原神 2.8 KCP 验证密钥交互流程解析与流量解密 As everyone knows, RSA is the most secure way to encrypt data

Sorapointa 49 Dec 29, 2022
A public board for all the Computer Society and Students to display their profile. An online year-book for you to display your profile in the most creative manner

Student's Yearbook by IEEE Computer Society Student's yearbook is an open-source project which intends to dispaly the students who will be graduating

IEEE Computer Society 11 Dec 18, 2022
Types generator will help user to create TS types from JSON. Just paste your single object JSON the Types generator will auto-generate the interfaces for you. You can give a name for the root object

Types generator Types generator is a utility tool that will help User to create TS Interfaces from JSON. All you have to do is paste your single objec

Vineeth.TR 16 Dec 6, 2022
Password Generator - A fast, simple and powerful open-source utility tool for generating strong, unique and random passwords

A fast, simple and powerful open-source utility tool for generating strong, unique and random passwords. Password Generator is free to use as a secure password generator on any computer, phone, or tablet.

Sebastien Rousseau 11 Aug 3, 2022
A powerful javascript library to create amazing and smooth effects for the mouse cursor on your website.

Cuberto Mouse Follower A powerful javascript library to create amazing and smooth effects for the mouse cursor on your website. Dependencies GSAP v3 (

Cuberto 410 Dec 30, 2022
Showcase your skills on your Github readme or resumé with ease ✨

Showcase your skills on your GitHub or resumé with ease! Powered by Cloudflare Workers ⚡ Docs Example Specifying Icons Themed Icons Icons Per Line Cen

Thijs [Coding] 1.6k Dec 31, 2022
our features are few but we provide the best and it is not uncommon to find in other npmjs

hikki-me our features are few but we provide the best and it is not uncommon to find in other npmjs Installation Install hikki-me with npm npm install

(Anto) 10 Jul 10, 2022
Jspreadsheet is a lightweight vanilla javascript plugin to create amazing web-based interactive tables and spreadsheets compatible with other spreadsheet software.

Jspreadsheet CE v4: The JavaScript spreadsheet Jexcel CE has been renamed to Jspreadsheet CE News Important: Please import jspreadsheet.css (jexcel.cs

null 6.2k Dec 19, 2022
Contribute on this repository with VALID PRs to HACKTOBERFEST-2022 and earn amazing swags!

LINK- https://rbshop.netlify.app/ Hacktoberfest2022 You can make folders of programming languages and also you can contribute in the repo's below. Fee

Ranodeep Banerjee 17 Oct 25, 2022
Convert your Postman documentation in a github´s readme.md ready format

Postman 2 Markdown Converter For that only time you need to convert your Postman documentation in a github´s readme ready format! Features & Problems

Andres Bastias 0 Sep 18, 2022