Skip to content

echeng8/GithubUserDataAPI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GithubUserDataAPI


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.

About The Project

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:

(back to top)

Built With

(back to top)

Getting Started

To get a local copy up and running follow these steps:

Prerequisites

Installation and Usage

  1. Clone the repo
git clone https://github.com/Frolicks/GithubUserDataAPI.git
  1. From the API folder directory, run
dotnet watch run

(back to top)

Usage

Request URL: localhost:{PORT}/api/UserData/Frolicks?includeForked=false

Curl:

curl -X 'GET' \
  'https://localhost:{PORT}/api/UserData/Frolicks?includeForked=false' \
  -H 'accept: text/plain'

(back to top)

Roadmap

  • Add front end with React
  • Host on Microsoft Azure

See the open issues for a full list of proposed features (and known issues).

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Evan Cheng - [email protected]

(back to top)

Acknowledgments

(back to top)

About

WebAPI to retrieve user data from Github. Made with ASP.NET

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages