📊 Project Metrics

🌟 Stars	🍴 Forks	🐛 Issues	🔔 Open PRs	🔕 Closed PRs

🔍Welcome to the awesome-github-profiles repo project! 🌟.

This README will guide you through the contribution process and provide essential information about the project.

Before Getting Started⭐

Watch the below video:

Running in your local directory ✨

• npm install ( this will install all the required npm modules)

1. Fork the Repository:

   • Click the "Fork" button on the top right of the repository page. This creates a copy of the repository under your GitHub account.

2. Clone Your Fork:

   • Run the following command in your terminal:

     git clone https://github.com/YOUR_USERNAME/awesome-github-profiles.git

   • This command downloads your fork to your local machine.

3. Create a Branch:

   • Navigate into the cloned repository and switch to the gh-pages branch:

     cd awesome-github-profiles
     git checkout gh-pages

   • Create a new branch for your feature or fix:

     git checkout -b your-feature-branch

4. Make Your Changes:

   • Implement your changes in your local repository. Make sure your code is clean and follows the project's coding style guidelines.

5. Test Your Changes:

   • If applicable, run tests to ensure that your changes do not break existing functionality.

     npm start

6. Stage Your Changes:

   • Use the git add command to stage the changes you want to commit.

     git add .  # Stages all modified files

   • You can also stage specific files by replacing . with the file names:

     git add <your filename> 

7. Commit Your Changes:

   • Commit your changes with a clear and descriptive message:

     git commit -m "Add a feature or fix a bug"

8. Push to Your Fork:

   • Push your changes back to your forked repository:

     git push origin your-feature-branch

9. Create a Pull Request:

   • Navigate to the original repository where you want to propose your changes.
   • Click on "New Pull Request" and follow the instructions to submit your changes for review. For even more detailed instructions on how to contribute, you can always check out the CONTRIBUTING.md file.

Screenshots of Features ✨

Home Page :

Login Page:

Add Profile:

Github Badge:

Code of Conduct

To foster a positive and inclusive community, please adhere to the following guidelines:

• Be Respectful: Treat everyone with respect. Engage in constructive conversations.
• No Harassment: Harassment, bullying, or discrimination will not be tolerated.
• Report Issues: If you witness or experience any unacceptable behavior, please report it to the project maintainers.

Please read the code of Conduct for more clear understanding.

Tutorials

• "Create Impressive GitHub Portfolio" - MTECHVIRAL

Contribute

Contributions are always welcome! To ensure a smooth collaboration process, Follow these steps:

Special Thanks 🙇

• Dinesh Talwadker Hemant, Nishant, Ayushman for being early contributor for this repo!

Contact Information

If you have questions, suggestions, or feedback, please reach out via email at [email protected].
You can also join our discussion forum here. We value open communication and are happy to help!

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Each profile in this repository is designed to showcase individual GitHub contributions effectively.

Sanjay KV 👀

Happy opensource and here’s to your career success! 🎉

re:codehive 2025

Website | Instagram | LinkedIn | Twitter | YouTube
🔔 Don’t miss a beat!
Subscribe to receive our newsletter directly in your inbox for the latest career insights & tailored to your journey.

Code Structure

The repository is organized into several main directories and files, each serving a specific purpose. Below is an overview of the main directories and files:

Directories

• assets: Contains various assets such as images, icons, and other media files used in the project.
• pages: Contains HTML files for different pages of the project, such as the home page, login page, and other feature-specific pages.
• scripts: Contains JavaScript files that provide functionality to the project, such as handling user interactions, fetching data, and manipulating the DOM.
• styles: Contains CSS files that define the styling and layout of the project.

Files

• index.html: The main HTML file that serves as the entry point for the project.
• README.md: The main README file that provides an overview of the project, instructions for contributing, and other important information.
• CONTRIBUTING.md: Contains guidelines and instructions for contributing to the project.
• CODE_OF_CONDUCT.md: Outlines the code of conduct for contributors to ensure a positive and inclusive community.

Each directory and file plays a crucial role in the overall structure and functionality of the project. Understanding the purpose of each component will help you navigate and contribute to the project more effectively.