Awesome Github Readme Generator

You can easily and quickly create a readme file for your GitHub profile or git hub repository. (visit below) (Click the Get Started button to start the process, Choose Github Readme Template you want, Fill in the desired fields, and press the Generate button to create your README.md file)

View Demo · Documentation · Report Bug · Request Feature

💻: Support Web Browser

Edge	Firefox	Chrome	Opera	Brave	Safari

📔 Table of Contents

• About the Project
  • Screenshots
  • Features
  • Environment Variables
• Getting Started
  • Run Locally
• Roadmap
• Contributing
  • Code of Conduct
• License
• Contact

🌟 About the Project

📷 Screenshots

• Github Readme File Generator GetStarted

• Fill in the desired fields

• Fill in the desired fields and press the generate button to create your README.md file (& new release)

🎯 Features

• Github Profile README.md Generator
• Github Repository README.md Generator

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file

GITHUB_ID

GITHUB_SECRET

GOOGLE_CLIENT_ID

GOOGLE_CLIENT_SECRET

NEXT_PUBLIC_SECRET

NEXT_PUBLIC_SKILL_API_KEY

🧰 Getting Started

🏃 Run Locally

Clone the project

  git clone https://github.com/SashenJayathilaka/Awesome-Github-Readme-Generator.git

Go to the project directory

  cd Github-Readme-File-Generator

Install dependencies

  npm install

Start the server

  npm run start

🧭 Roadmap

• Github Profile README.md Generator
• Github Repository README.md Generator

👋 Contributing

Contributions are always welcome!

See contributing.md for ways to get started.

📜 Code of Conduct

Please read the Code of Conduct

💻 Built with

• Next Js
• Tailwind CSS: for styling
• Framer Motion: for Animations

🙇 Special Thanks

• Anurag Hazra for amazing github-readme-stats
• ryo-ma for amazing github-profile-trophy
• Casper for amazing github-profile-summary-cards
• Ashutosh Dwivedi for amazing github-readme-activity-graph
• Anton Komarev for super cool github-profile-views-counter
• Jonah Lawrence for the incredible github-readme-streak-stats
• Julien Monty for super useful devicon

⚠️ License

Distributed under the no License. See LICENSE.txt for more information.

🤝 Contact

My Name - Sashen Jayathilaka - [email protected]

Project Link: https://github.com/SashenJayathilaka/Awesome-Github-Readme-Generator.git