A Web API to get a Github User's stats in JSON format. Stats include total repositories, stargazers, forks; as well as average repo size and popular languages.
This Web API was created as a take home assignment for a Software Developer Internship application.
Key Features
- Separation of Concerns: Separate projects for API and Application
- Inversion of Control: Dependency injection used to connect the Application to the API
Constraints:
- Total Repo size doesn't account for shared objects, and thus may be less than actual size: https://stackoverflow.com/questions/8646517/how-can-i-see-the-size-of-a-github-repository-before-cloning-it
To get a local copy up and running follow these steps:
- Clone the repo
git clone https://github.com/Frolicks/GithubUserDataAPI.git- From the API folder directory, run
dotnet watch runRequest URL: localhost:{PORT}/api/UserData/Frolicks?includeForked=false
Curl:
curl -X 'GET' \
'https://localhost:{PORT}/api/UserData/Frolicks?includeForked=false' \
-H 'accept: text/plain'
- Add front end with React
- Host on Microsoft Azure
See the open issues for a full list of proposed features (and known issues).
Distributed under the MIT License. See LICENSE.txt for more information.
Evan Cheng - [email protected]
- Octokit Github .NET API https://github.com/octokit
- ByteSize Utility Class https://github.com/omar/ByteSize
- othneildrew's Readme Template 'https://github.com/othneildrew/Best-README-Template