About | Technologies | Requirements | Starting | Contributing
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!
https://user-images.githubusercontent.com/54520907/173442002-dafc63ea-321f-4ce2-b349-be490b3a00ff.mp4
###
Before starting :checkered_flag:, you need to have Git and Node installed (nvm recommended).
# 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>
dev
: starts the application at localhost:3000
build
: creates an optimized production build of applicationstart
: starts the application in production mode at localhost:3000
(have run the build before)test
: run the testslint
: run eslint in /srcThis project is under license from MIT. For more details, see the LICENSE file.
Made with :heart: by Mauro de Souza
Readme created with Simple Readme