Skip to content

Latest commit

 

History

History
52 lines (25 loc) · 2.5 KB

README.md

File metadata and controls

52 lines (25 loc) · 2.5 KB

TWEB Labo 1 : Mining Data in Github

This repository contains the result of the fist lab session for Antoine Drabble and Guillaume Serneels in the TWEB Course 2016-2017 at HEIG-VD.

The project is aimed at developing and deploying an AngularJS 1 web application allowing users to explore usage statistics of github.com. The users are first welcomed by a landing page and can click on the "START EXPLORING NOW" link to access the webapp.

Project structure

branch gh-pages : Landing Page

The gh-pages branch of this repository contains the landing page of the github explorer web app.

The landing page is made available using GitHub Pages an can be accessed at the following URL:

https://gsern1.github.io/TWEB-Labo1-GithubExplorer/

branch master : Github explorer web application

The master branch of this repository contains the source code of the github explorer web app as deployed on heroku.

To develop this project we have first created an AngularJS application using the angm generator. The application's navigation relies on the UI-Router framework and the charts display is made possible by the angular-chart.js (based on Chart.js) module.

The aplication's database has been created with MongoDB. It is used to store the list of the most starred repos on github when the app is launched and to log every query executed on the feature 2 of the app.

This AngularJS application was then incorporated inside a simple Node.js app using Expess 4, and deployed to heroku, along with the mLab MongoDB module.

Here's the adress of the heroku deployement:

https://tweb-github-explorer.herokuapp.com/

html template

The html template we're using is Future Imperfect from html5up.

GitHub Explorer features

Feature 1 : most starred repos

List the most starred repositories on GitHub. The data is fetched when the server starts and is stored in the MongoDB database.

Feature 2 : repository commiters

See every user who commited to the repository of your choice and the percentages of their contribution.

See an historic of every request which were executed on this feature

Feature 3 : user's repositories

List all the repositories of the user of your choice