Skip to content

mrjuice01/Readme.MD-Generator

Repository files navigation

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

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! ✨ You can include whatever content you want, wherever you want it (within the limitations of markdown, of course). 📝

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

Don't miss out on the opportunity to enhance your GitHub profile. Give it a try and see for yourself how easy and convenient it is! 😉

Loved the tool? Please consider donating 💸 to support its continuous
improvement and development!

profile-readme-generator.mp4

🚀 Main Technologies

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

See more

✅ 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/mrjuice01/mrjuice01/Readme.MD-Generator
# Access
$ cd Readme.MD-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 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.


Support

Mr Juice

Author

GitHub YouTube Telegram Instagram