Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ryantusi/github_profile_readme_generator

The GitHub Profile README Generator is a web-based tool that empowers users to create dynamic and eye-catching READMEs for their GitHub profiles. It enables users to showcase their personality and achievements in a visually appealing format.
https://github.com/ryantusi/github_profile_readme_generator

codecrafts cs50 final-project github-api github-profile-readme harvard readme-generator

Last synced: about 1 month ago
JSON representation

The GitHub Profile README Generator is a web-based tool that empowers users to create dynamic and eye-catching READMEs for their GitHub profiles. It enables users to showcase their personality and achievements in a visually appealing format.

Awesome Lists containing this project

README 

        
# 👨‍💻 GitHub Profile README Generator

### Video demo: [click here](https://www.youtube.com/watch?v=Io-POzQf4jc)



![Project Banner](screenshots/codecrafts.png)



The GitHub Profile README Generator is a web-based tool that empowers users to create dynamic and eye-catching READMEs for their GitHub profiles. The generator allows users to customize their README with various sections, including user description, skills, GitHub stats, trophies, and more. It enables users to showcase their personality and achievements in a visually appealing format.



## 🚀 Features



- **Customizable Sections**: Tailor your profile README with various sections like About Me, Skills, Stats, Trophies, and more.

- **Dynamic Content**: Generate markdown content that dynamically updates based on user preferences and input.

- **Image and Link Integration**: Include images, links, and badges to enhance your profile README.

- **GitHub Stats and Trophies**: Display your GitHub stats and achievements using GitHub API integration.

- **Skill Sets**: Showcase your skillset with out customized svg files.



## 📝 How to Use



1. **Access the Generator**: Visit the [Codecrafts](https://ryantusi.github.io/Github_Profile_README_Generator/) website.

2. **Customize Your README**: Select the sections you want to include, provide the necessary details, and customize the appearance.

3. **Generate README**: Click the 'Generate README' button to generate the markdown code for your profile README.

4. **Copy Markdown**: Copy the generated markdown and paste it into your GitHub profile's README.md file.

5. **Commit Changes**: Commit the changes to your GitHub profile to update your README.



## 🖼️ Screenshots



![Screenshot 1](screenshots/cc_sc1.png)

![Screenshot 2](screenshots/cc_sc2.png)

![Screenshot 3](screenshots/cc_sc3.png)

![Screenshot 4](screenshots/cc_sc4.png)

![Screenshot 5](screenshots/cc_sc5.png)






## 💻 Technologies Used



- HTML5

- CSS3

- Bootstrap

- JavaScript

- GitHub API



## 📄 Files



**Branches**: 

- `main` branch: contains source code and assets

- `host` branch: for hosting pages



**src**: This contains all the source code and assets like images and icons

- `script.js`: main javascript file generates plain form text into markdown format text with github API

- `/templates`: contains HTML files: `index.html` and `github.html`

- `/static`: contains CSS file: `styles.css`

- `/images`: contains assets like images and icons rendered in HTML files



## 🤝 Contribution



Contributions are welcome! If you have ideas for enhancements or bug fixes, feel free to create issues or pull requests.



## 📄 License



This project is licensed under the [MIT License](LICENSE).



## 🙏 Acknowledgements



This is the final project for CS50 course by Harvard University.



- [Ryan Tusi](https://github.com/ryantusi/) - [Connect with me](https://www.linkedin.com/in/ryantusi/)

- [Harvard CS50](https://pll.harvard.edu/course/cs50-introduction-computer-science)