opw0011 / github-langs

:checkered_flag: Show programming language based on the repos of :octocat:'s account.

Github Language Checker

What ?

Useful web checker to see what languages are used from a github account.

Go to the web!

Why ?

Let everyone know their languages statistic on github repo.

Running the app locally

• Generate a GitHub OAuth client id and client secret to ensure you don't get rate limited API call.
• Create .env file with this content :

CLIENT_ID=your_client_id
CLIENT_SECRET=your_client_secret

• Install dependency : npm install

• ALWAYS run test before start the app : npm run lint

• Start the app npm start and go to : http://localhost:5000

Running app through Docker

• Build image : docker build -t local/github-langs .
• Run image : docker run -v `pwd`/tests/screenshot-testing/screenshots:/app/tests/screenshot-testing/screenshots -v `pwd`/views:/app/views -v `pwd`/lib:/app/lib -it -p 5000:5000 --env-file .env local/github-langs
• Start server in appeared terminal : npm start
• App is now available on http://localhost:5000

Testing app through Docker

• Build image : docker build -t local/github-langs .
• Run image : docker run -v `pwd`/tests/screenshot-testing/screenshots:/app/tests/screenshot-testing/screenshots -v `pwd`/views:/app/views -v `pwd`/lib:/app/lib -it -p 5000:5000 --env-file .env local/github-langs
• Redirect display output to xvfb : source start-xvfb.sh
• Execute tests : npm test

TO DO LIST (ordered by priority) :

• : Show repo > 100 (currently, only support repo < 100)
• : Add vertical bar based on languages
• : Refactor the controller (urgent) #22
• : Beautify the page #16
• : Toggle graph color (white or colorful)
• : Save graph as image
• : Add social button (fb share & twitter tweet)
• : Redirect to /me if user already logged in (Github)
• : Improve UI
• : Increase speed & security

Contributing

Check out this page

Related project(s)

• Githut

License :

MIT (c) Wildan S. Nahar 2017