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

Styled Media Query

Framer Motion

HTML Prettify

React Share

Prismjs

UUID

✅ 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

GitHub

View Github