Admission Test for ADP

This repository contains the admission test for ADP. It's a visualizer of public github repositories that does the sum of the number of subscribers of selected repositories. It's written in AngularJS using NPM (package manager), Webpack (module loader), Bootstrap, Karma/Jasmine (test runner and framework respectively) and Travis-CI.

Setup

To start this repository you must clone it and then navigate into its folder, as follows:

 git clone https://github.com/Zugruul/test-adp.git
 cd test-adp

then yo must install the project dependencies, to do so run the following command:

 npm install

Once the repository has been cloned and it's dependencies installed you can proceed. The following sections explain how to run the project both in development and in production modes.

Run in Development Mode

To run in development mode run the following:

npm start

To build in development mode run the following:

npm run build:dev

Run tests

To run the unit tests run the following:

npm run test

To check code coverage run the following:

npm run test:coverage

Run in Production Mode

To run in production mode run the following command:

npm run build:prd

To run the production build you need to serve it somehow. I recommend http-server. To install it (globally):

npm i -g http-server

To serve the build files and start an server:

http-server

Note: By default the server will run on localhost:8080. But watch your terminal logs for more info.

Problems you may encounter

As of right now I didn't plan on a way to get an access token dynamically. So beware of reloading as there is a 5000 api requests limit to github (unauthenticated). To mitigate this you may modify the file located at src/config/index.js with your token. Note: You can get an access token by going here and generating one.

Notes and Todos

I used Travis-CI (took my time to learn it a bit, using a pre-build script I found) to ensure that tests were passing as of each commit. (Ofcourse the ones I was setting things up caused some red 'flags'! :p) Some problems I would like to present:

As of this commit the header and footer directives are dependent on the repository directive. Thats something I would like to have had time to refactor.
As of for tests I didn't have time to really play a lot with them using AngularJS. I worked most of my free time on understanding AngularJS modules, injection to create tests that test what the user will interact and try to do and verify that all functionalities work according to some sidenotes I should've included here (BDD I've done).
I would've liked to have more time to study AngularJS code architecture and good practices. But as of right now I can't. I'm sure that there is lots more I could've have done, but those two are the things I would like to comment on.

Coverage summary

Statements   : 89.52% ( 188/210 )
Branches     : 57.14% ( 8/14 )
Functions    : 75% ( 33/44 )
Lines        : 91.15% ( 175/192 )
Total of 12 successful tests

Seed

This project was created using the following seed: https://github.com/zxbodya/angular-webpack-seed

Zugruul / test-adp