Skip to content
This repository was archived by the owner on Sep 19, 2024. It is now read-only.

Commit 90a1e79

Browse files
committed
updated readme
1 parent 5f8939d commit 90a1e79

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

README.md

+34
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,47 @@ Furthermore, even for the contributors, discovering interesting and contributabl
77
GitLit is a web app that rates repositories and contributors through a logical algorithm which takes into consideration not only a few standard metrics like Stars, Forks, and PRs, but also accounting for factors like Activity in the Community (eg: Issue Resolution, Feature Addition), backgrounds of the contributors etc.
88

99
# Target Customers
10+
GitLit has two primary use-cases, one for the developers to discover interesting projects and the other is for
11+
people in the industry to find talented and enthusiatic developers.
12+
13+
**Project Discovery**
14+
15+
* **Students & Beginners:** GitLit can be used by students and beginners to get started into the world of Open Source.
16+
It helps them to break-the-ice, and kick-start their FOSS journey without essentially going into deeper level they can.
17+
18+
* **Developers** GitLit can also be used by amateur as well as professional developers to discover innovate, interesting
19+
and relevant projects to contribute to, based on their skill level.
20+
21+
**Developer Discovery**
22+
23+
* **Developer Advocates:** GitLit can be used by developer advocates to identify enthusiastic and talented
24+
contributors, who are interested in their organization, and connect with them. It can be also used by them to analyse
25+
their projects, and monitor community members.
26+
27+
* **College Clubs:** College based computer clubs like amFOSS, can use GitLit to identify enthusiastic and talented
28+
students out of a large pool, effectively monitor them and check their progress.
29+
30+
* **Corporate Recruiters:** Corporate companies can discover developers, with the required talent and passion using
31+
credible metrics of GitLit
1032

1133
# How it Works?
1234

1335
## Algorithms
1436

1537
# Tech Stack
1638

39+
* **Language:** Python 3.6
40+
* **Framework (full-stack):** Django
41+
* **API:** GraphQL (Github API 4), Rest API (Github API 3)
42+
* **Frontend Frameworks:** Bootstrap 4
43+
* **Javascript Libraries:** jQuery
44+
* **Stylesheet Pre-processors:** Sass
45+
1746
# Contributors
1847

48+
1. Venu Vardhan Reddy
49+
2. Akhil K, Gangadharan
50+
3. Ashwin S Shenoy
51+
1952
# License
53+

algorithms/README.MD

+3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
11
# GitLit Algorithms
22

3+
34
## Rating Algorithm
45

56
### User Rating
67

8+
79
#### Metrics Used
810

11+
912
### Repository Rating
1013

1114
#### Metrics Used

0 commit comments

Comments
 (0)