README.md

UPDATED

Fork of maurodesouza

*✨ feat: add 💾 local file backup & restore feature #74

Live

https://profile-readme-maker.vercel.app

---

Demo

---

            _.------.                        .----.__
           /         \_.       ._           /---.__  \
          |  O    O   |\\___  //|          /       `\ |
          |  .vvvvv.  | )   `(/ |         | o     o  \|
          /  |     |  |/      \ |  /|   ./| .vvvvv.  |\
         /   `^^^^^'  / _   _  `|_ ||  / /| |     |  | \
       ./  /|         | O)  O   ) \|| //' | `^vvvv'  |/\\
      /   / |         \        /  | | ~   \          |  \\
      \  /  |        / \ Y   /'   | \     |          |   ~
       `'   |  _     |  `._/' |   |  \     7        /
         _.-'-' `-'-'|  |`-._/   /    \ _ /    .    |
    __.-'            \  \   .   / \_.  \ -|_/\/ `--.|_
 --'                  \  \ |   /    |  |              `-
                       \uU \UU/     |  /



                                ,     /~/'   ,--,
                               _/`, ,/'/'   /'/~
                             .'___|/ /____/'/'   __/|
                             /~  __        `\ /~~, /'
                      _,-,__/'  ,       \   /'/~/ /'
                    .~      `   \_/  / ,     "~_/'  ,-'~~~~~---,_
                    `,               `~    `~~~|   /'    ~~\__   `~\_
            |~~~/     `~---,__        _,      /'  | /~~\  _/' ~~\    `~,
            |/\`\          /'     _,-~/      /'  .' __ `/'       `~\    \
   |~~~/       `\`\        `-\/\/~   /'    .'    |    `| \/    |    `\_  |
   |/\`\         `,`\              /'      |_  ,' /~\ /' |' |  `\     \~\|
      `\`\    _/~~_/~'            /'      /' ~~/     /   `\ `\,  | \   |
~/      `\`\/~ _/~                ~/~~~~\/'    `\__/' \/\  `\_/\ `\~~\ |
\`\    _/~'    \               /~~'                `~~~\`~~~'   `~~'  `'__
 `\`\/~ _/~\    `\           /' _/                      `\        _,-'~~ |
   `\_/~    `\    `\       _|--'                          |      `\     |'
              `\    `\   /'          _/'                  |       /' /\|'
                /\/~~\-/'        _,-'                     |     /' /'  `
                |_`\~~~/`\     /~                          \/~~' /'
                   |`\~ \ `\   `\                           `| /'



                      .-.
         heehee      /aa \_
                   __\-  / )                 .-.
         .-.      (__/    /        haha    _/oo \
       _/ ..\       /     \               ( \v  /__
      ( \  u/__    /       \__             \/   ___)
       \    \__)   \_.-._._   )  .-.       /     \
       /     \             `-`  / ee\_    /       \_
    __/       \               __\  o/ )   \_.-.__   )
   (   _._.-._/     hoho     (___   \/           '-'
hah '-'                        /     \
                             _/       \    teehee
                            (   __.-._/




         ___---___
      .--         --.
    ./   ()      .-. \.
   /   o    .   (   )  \
  / .            '-'    \
 | ()    .  O         .  |
|                         |
|    o           ()       |
|       .--.          O   |
 | .   |    |            |
  \    `.__.'    o   .  /
   \                   /
    `\  o    ()      /'
      `--___   ___--'
            ---


  .             *        .     .       .
       .     _     .     .            .       .
.    .   _  / |      .        .  *         _  .     .
        | \_| |                           | | __
      _ |     |                   _       | |/  |
     | \      |      ____        | |     /  |    \
     |  |     \    +/_\/_\+      | |    /   |     \
 ___/____\--...\___ \_||_/ ___...|__\-..|____\____/__
      .     .      |_|__|_|         .       .
   .    . .       _/ /__\ \_ .          .
      .       .    .           .         .



         _..._
       .:::::::.
      :::::::::::
      :::::::::::
      `:::::::::'
        `':::''
         _..._
       .::::. `.
      :::::::.  :
      ::::::::  :
      `::::::' .'
        `'::'-'
         _..._
       .::::  `.
      ::::::    :
      ::::::    :
      `:::::   .'
        `'::.-'
         _..._
       .::'   `.
      :::       :
      :::       :
      `::.     .'
        `':..-'
         _..._
       .'     `.
      :         :
      :         :
      `.       .'
        `-...-'
         _..._
       .'   `::.
      :       :::
      :       :::
      `.     .::'
        `-..:''
         _..._
       .'  ::::.
      :    ::::::
      :    ::::::
      `.   :::::'
        `-.::''
         _..._
       .' .::::.
      :  ::::::::
      :  ::::::::
      `. '::::::'
        `-.::''
         _..._
       .:::::::.
      :::::::::::
      :::::::::::
      `:::::::::'
        `':::''



   ______            ______            ______
  /\_____\          /\_____\          /\_____\          ____
 _\ \__/_/_         \ \__/_/_         \ \__/_/         /\___\
/\_\ \_____\        /\ \_____\        /\ \___\        /\ \___\
\ \ \/ / / /        \ \/ / / /        \ \/ / /        \ \/ / /
 \ \/ /\/ /          \/_/\/ /          \/_/_/          \/_/_/
  \/_/\/_/              \/_/

 _________
|  _____  |\
| |\ ___| | \
| | |   | | |
| | |___| | |
\ | |____\| |
 \|_________|
      __        __
     /\ \      /\ \
    /  \ \    /  \ \
   / /\ \ \  / /\ \ \
  / / /\ \ \/ / /\ \ \
 / / /__\_\/ / /__\_\ \
/ / /______\/ /________\
\/_____________________/

._____. ._____.
| ._. | | ._. |
| !_| |_|_|_! |
!___| |_______!
.___|_|_| |___.
| ._____| |_. |
| !_! | | !_! |
!_____! !_____!
 .--..--.
/ .. \.. \
\ \/\ \/ /
 \/ /\/ /
 / /\/ /\
/ /\ \/) \
\ `'\ `' /
 `--'`--'

    ________
   /_______/\
   \ \    / /
 ___\ \__/_/___
/____\ \______/\
\ \   \/ /   / /
 \ \  / /\  / /
  \ \/ /\ \/ /
   \_\/  \_\/

 _   _   _
(_) (_) (_)
| | | | | |
| | | | | |
| | | | | |
| | | | | |
| | | | | |
| | |_| | |
\ | |__\| |
 \|_______|

   __        __
  /\ \      / /\
 / /\ \    / /\ \
/ /__\ \__/_/__\ \
\/____\ \_______\/
        \/ /
       / /\
      / /\ \
     / /__\ \
     \_____\/
          _______
         /       /
___     /   ____/
\   \  /   /\
 \   \/___/  \
  \       \   \
   \_______\   \
           /   /
          /   /
          \  /
           \/
     ____________
    /___________/\
   _\ \________/_/_
  /__\ \__________/\
 _\ \_\_\____/ /_/_/_
/\_\ \______/ /______\
\ \ \ \ \ \/ / / / / /
 \ \ \ \ \ \/ / / / /
  \ \ \ \/\ \/ / / /
   \ \ \/ /\/ / / /
    \ \/ /\/ /\/ /
     \/_/\_\/\/_/
          ____
         /.../\
        /.../--\
       /.../----\
      /.../------\
     /.../---/\---\
    /.../---/\\\---\
   /.../---/\\\\\---\
  /.../===/__\\\\\---\
 /............\\\\\---\
/..............\\\\\---\
\\\\\\\\\\\\\\\\\\\\\--/
 \\\\\\\\\\\\\\\\\\\\\/
      ____________
     /\  ________ \
    /  \ \______/\ \
   / /\ \ \  / /\ \ \
  / / /\ \ \/ / /\ \ \
 / / /__\_\/ / /__\_\ \
/ /_/_______/ /________\
\ \ \______ \ \______  /
 \ \ \  / /\ \ \  / / /
  \ \ \/ / /\ \ \/ / /
   \ \/ / /__\_\/ / /
    \  / /______\/ /
     \/___________/

      ____________
     /___________/\
     \ \        / /
     _\ \______/_/_
    /__\ \________/\
 ___\ \_\_\__/ /_/_/___
/\___\ \____/ /_______/\
\ \   \ \ \ \/ / /   / /
 \ \   \ \/\ \/ /   / /
  \ \   \/ /\/ /   / /
   \ \  / /\/ /\  / /
    \ \/ /\_\/\ \/ /
     \/_/      \_\/
      ____________
     /\  ________ \
    /  \ \______/\ \
   / /\ \ \  / /\ \ \
  / / /\ \ \/ / /\ \ \
 / / /__\_\/ / /__\_\ \
/ /_/_______/ /________\
\ \ \______ \ \______  /
 \ \ \  / /\ \ \  / / /
  \ \ \/ / /\ \ \/ / /
   \ \/ / /__\_\/ / /
    \  / /______\/ /
     \/___________/
           ____
          /   /\
         /___/  \
        /   /\  /\
       /   /  \/  \
      /   /   /\   \
     /   /   /  \   \
    /   /   /\   \   \
   /   /   /  \   \   \
  /___/___/____\   \   \
 /   /          \   \  /\
/___/____________\___\/  \
\   \             \   \  /
 \___\_____________\___\/

           ____
          /\   \
         /  \   \
        /    \   \
       /      \   \
      /   /\   \   \
     /   /  \   \   \
    /   /    \   \   \
   /   /    / \   \   \
  /   /    /   \   \   \
 /   /    /---------'   \
/   /    /_______________\
\  /                     /
 \/_____________________/

               ____
             / \   \
            /   \___\
           _\   /   /__
         / \ \ /_/ \   \
        /   \___/   \___\
       _\   /   \   /   /__
     / \ \ /___/ \ /_/ \   \
    /   \___\       /   \___\
   _\   /   /__     \__ /  _/__
 / \ \ /___/   \ / \   \ / \   \
/   \___\   \___\   \___\   \___\
\   /   /   /   /   /   /   /   /
 \ /___/ \ /___/ \ /___/ \ /___/
           ____
          /\   \
         /  \___\
        _\  / __/_
       /\ \/_/\   \
      /  \__/  \___\
     _\  /  \  / __/_
    /\ \/___/\/_/\   \
   /  \___\    /  \___\
  _\  /   /_  _\__/ __/_
 /\ \/___/  \/\   \/\   \
/  \___\ \___\ \___\ \___\
\  /   / /   / /   / /   /
 \/___/\/___/\/___/\/___/
          ________                         ________
         /\       \                       /\       \
        /  \       \                     /  \       \
       /    \       \                   / /\ \       \
      /   3  \_     _\                 / /  \ \       \
     /\      /\      /\               / /    \ \       \
    /_      /  \_     _\             / /      \ \       \
   /\      /   /\       \           / /   /\   \ \       \
  /      \/___/  \       \         / /   /  \   \ \       \
 /       /    \   \       \       / /   / /\ \   \ \       \
/      \/______\___\_______\     / /   / / /\ \   \_\_______\
\      /       /   /       /     \ \   \/_/  \ \  / /       /
 \    /                   /       \ \    /----\-\- /       /
  \  /   1           2   /         \ \__/------\- /       /
   \/_______/__\/_______/           \/_/        \/_______/
          ________
         /\       \
        /  \       \
       /    \       \
      /      \_______\
      \      /       /
    ___\    /   ____/___
   /\   \  /   /\       \
  /  \   \/___/  \       \
 /    \       \   \       \
/      \_______\   \_______\
\      /       /   /       /
 \    /       /   /       /
  \  /       /\  /       /
   \/_______/  \/_______/

       ______________
      /_____________/\
      \ \          / /
    ___\ \________/_/___
   /____\ \____________/\
   \ \   \ \    / /   / /
 ___\ \___\_\__/ /___/_/___
/\___\ \______/ /_________/\
\ \   \ \   \ \/   / /   / /
 \ \   \ \  /\ \  / /   / /
  \ \   \ \/ /\ \/ /   / /
   \ \   \/ /  \/ /   / /
    \ \  / /\  / /\  / /
     \ \/ /\ \/ /\ \/ /
      \_\/  \_\/  \_\/

  ________________
 /_______________/\
 \ \            / /
  \ \    ______/_/_______
   \ \  /\______________/\
 ___\ \_\_\__/ /_      / /
/\___\ \____/ /__\    / /
\ \   \ \ \ \/ / /   / /
 \ \   \ \/\ \/ /   / /
  \ \   \/_/\/ /   / /
   \ \      / /\  / /
    \ \    / /\ \/ /
     \ \  / /  \_\/
      \ \/ /
       \/_/

---

GitHub Profile Readme Maker

About   |   Technologies   |   Requirements   |   Starting   |   Contributing

🎯 About

Are you tired of manually editing your GitHub profile or missing out on the amazing features you can add to it? 😩 Configuring GitHub actions can also be a hassle, right? Say no more! 💪

Introducing a tool that lets you beautify your GitHub profile with a customized README, easily and in no time! ✨

With this tool, creating your README has never been so simpler ⚡ You can save time and focus on what really matters - showcasing your skills and projects. 🚀

profile-readme-generator.mp4

🚀 Main Technologies

                   

See more

• Styled Icons (Feather Icons)
• Styled Media Query
• Framer Motion
• HTML Prettify
• React Share
• Prismjs
• UUID

✅ Requirements

Before starting 🏁, make sure you have Git and Node installed on your system. (nvm recommended).

🏁 Starting

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

# Access
$ cd profile-readme-maker

# Install dependencies
$ pnpm

# Run the project
$ npm run 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 the application;
• start: starts the application in production mode at localhost:3000 (make sure to run the build first);
• test: runs the tests;
• lint: runs eslint in the /src directory.

📝 License

This project is licensed under the MIT License. For more details, please refer to the LICENSE file.

Made with ❤️ by metaory, Mauro de Souza

 

Back to top