README.md

GitLit 🔥

GitLit is a social network exclusively for Open-Source developers. It works by connecting enthusiastic developers to the most interesting and relevant projects to them and forming new communities of like-minded and passionate developers.

🤔 Why GitLit?

1. It is difficult to find contributable projects - What if you can get a dashboard full of project and issues suggestions, which are relevant to you - both skill and interest wise?

2. There is no standards to rate and classify developers & projects

🌟 Top Features

1. Advanced Rating System for Contributor's & Repositories on GitHub
2. Intelligent Identification of Contributor's Interest & Skills
3. Smart & Relevant Mapping of Repositories & Contributor's based on shared interests and skill-level.
4. Suggestion feed of contributable repositories, and notifications for fixable issues
5. View similar repositories and users
6. Intelligent Insights with actionable feedbacks & checklist for contributors and repositories

Target Users

There are two primary use-cases for GitLit, one for the developers to discover interesting projects and the other is for people in the industry to find talented and enthusiastic developers.

Project Discovery

• Students & Beginners: GitLit can be used by students and beginners to get started into the world of Open Source. It helps them to break-the-ice, and kick-start their FOSS journey without essentially going into deeper level.

• Developers GitLit can also be used by amateur as well as professional developers to discover innovative, interesting and relevant projects to contribute to - based on their skill level.

Developer Discovery

• Developer Advocates: GitLit can be used by developer advocates to identify enthusiastic and talented contributors, who are interested in their organization, and connect with them. It can be also used by them to analyse their projects, and monitor community members.

• College Clubs: College based computer clubs like amFOSS, can use GitLit to identify enthusiastic and talented students out of a large pool and effectively monitor and check their progress.

• Corporate Recruiters: Corporate companies can discover developers, with the required talent and passion using credible metrics of GitLit.

📑 Documentation

• Algorithms
  • Documentation
  • Working Code
• Data Sourcing & Processing
  • GitHub API
  • Limitations in Sourcing & Processing
• Rating Metrics
  • User Metrics
  • Repository Metrics
• Interest Identification
  • Using GitHub Topics as basis for Interest Classfication
  • Finding User's Topics of Interest
  • Weighting Topics of Interest
  • Identification of Project Topics
• Matching & Mapping

🔌 How it Works?

Suggestion Panel to help developers

1. Fetches all data about a developer, once a developer signs-up.
2. After analysing his previous contribution pattern, an complex algorithm rates the developer using smart metrics, and classifies him into interest groups.
3. Based on his interests, and his skill in the given topic of interest, an ML-based matching algorithm matches it with most relevant projects
4. The developer recieves relevant and interesting suggestions for projects, and issues.

Discovery Panel to help projects

🔩 Tech Stack

• Language: Python 3.6
• Framework (full-stack): Django
• API: GraphQL (Github API 4), Rest API (Github API 3)
• Frontend Frameworks: Bootstrap 4
• Javascript Libraries: jQuery
• Stylesheet Pre-processors: Sass

👥 Creators

1. Venu Vardhan Reddy
2. Akhil K Gangadharan
3. Ashwin S Shenoy

👨‍💻 Core Contributors

1. Puneeth Chanda

Contributions are welcome! <3

✒️ License

GNU General Public License v3.0