Rankings using GitHub API, specially focused on location
Switch branches/tags
Nothing to show
Clone or download
Latest commit 896a1e4 Jun 23, 2017
Permalink
Failed to load latest commit information.
img Adding arrows to users in ranking (only in provinces) Aug 2, 2015
layout Fixed logo path Apr 8, 2016
lib Gets only users Jun 23, 2017
test Just moving things Jan 20, 2015
.gitignore Update. Apr 22, 2013
README.md Adapta README y TODO Dec 23, 2014
TODO.md Check tasks and add new ones Mar 7, 2015
alava.json Updating configurations galore Mar 4, 2016
albacete.json Añade otra ciudad Dec 18, 2015
alicante.json Corrige Alicante con Elche y usa ya formato de @iblancasa May 31, 2015
almeria.json Updating configurations galore Mar 4, 2016
andalucia.json Region-wide config Apr 11, 2015
asturias.json Updating configurations galore Mar 4, 2016
avila.json Fixes Ávila Apr 8, 2016
badajoz.json Minor changes for merger May 4, 2015
baleares.json Cambia la configuración Apr 22, 2016
barcelona.json Adds more locations Apr 26, 2016
bilbao.json Giving up, this morning nothing is working May 10, 2015
cadiz.json Fixing Cádiz Jan 4, 2016
canarias.json Giving up, this morning nothing is working May 10, 2015
cantabria.json Updates navarra Mar 4, 2016
castellon.json Updating configurations galore Mar 4, 2016
catalunya.json Added new conf file Apr 15, 2015
ceuta.json Configurations with less pages Feb 10, 2015
check-all.sh Add config checker Mar 27, 2015
check-api-searches.coffee Less requests per minute and changing BCN Apr 11, 2015
ciudadreal.json Updating conf files Feb 15, 2015
config.json Adds configurable templates Dec 21, 2014
cordoba.json Añade filtros May 12, 2016
coruña.json Took a while, but it works now... Oct 18, 2015
cuenca.json Updates conf Mar 1, 2015
donostia.json Updating configurations galore Mar 4, 2016
dublin.json Modifica conf Nov 19, 2015
españa.json Adds more locations Apr 26, 2016
euskadi.json Giving up, this morning nothing is working May 10, 2015
extremadura.json New region: Extremadura May 4, 2015
galicia.json And now another country in Spain May 2, 2015
gerona.json Updating configurations galore Mar 4, 2016
get-AND.coffee Does not work well, but... Jan 12, 2015
get-city-users.coffee Gets only users Jun 23, 2017
get-city.coffee Got it working with templates Dec 17, 2014
get-cutoff.pl MAD and BCN modified Mar 6, 2015
granada.json Updates conf Jun 23, 2017
guadalajara.json new one Feb 9, 2015
huelva.json Updating configurations galore Mar 4, 2016
jaen.json Adds new province with variations Apr 6, 2015
leon.json More filters Feb 10, 2015
lleida.json Updating configurations galore Mar 4, 2016
lugo.json Lugo para los filtros May 31, 2015
madrid.json Adds more locations Apr 26, 2016
malaga.json Fixes logic problems Jan 11, 2015
melilla.json Corrige Melilla Feb 23, 2015
merge-city.coffee Updated with position change in Spain ranking Jun 9, 2016
merge-json-files.coffee Minor changes for merger May 4, 2015
murcia.json Updating confs Dec 11, 2015
navarra.json Updates navarra Mar 4, 2016
orense.json Updating configurations galore Mar 4, 2016
package.json Alt top Jan 20, 2015
palmas.json Updating configurations galore Mar 4, 2016
pontevedra.json Updating configurations galore Mar 4, 2016
portugal.json Updates Portugal after checking Mar 27, 2015
reykjavik.json Adds Conf with alt spelling Aug 16, 2015
rioja.json Updating configurations galore Mar 4, 2016
salamanca.json New conf Salamanca Feb 10, 2015
sevilla.json Updates conf Jun 23, 2017
slovenia.json Modularizes and adds new country Mar 26, 2015
soria.json Añade ciudades principales Jun 21, 2015
tenerife.json Limita número de páginas Sep 21, 2015
toledo.json Updated confs May 12, 2015
valencia.json Updating configurations galore Mar 4, 2016
valladolid.json Ahora valladolid Nov 19, 2015
zaragoza.json Updating configurations galore Mar 4, 2016

README.md

GitHub City Rankings

This project is a fork of Top GitHub Users by Paul Miller.

Usage

First, create the directories where data is going to be placed. These directories will be defined in config.json. Create an ID and SECRET in your GitHub account. If you don't, you wont be able to do more than a couple of runs per hour (20 request in total). Then, set them with

export GH_ID=LONG_HEXA_number
export GH_SECRET=EVEN_LONGER_HEXA_number

Install node.js and coffeescript. You're better off if you install nvm and then proceed from there. Once node is installed,

# Global install coffeescript
npm install -g coffee-script
# Install deps. from package.json
npm install

Cities can be configured by ECT templates, which reside in the layout dir; for the time being there is only one for Granada. If you want to use that template, or any other thing such as a particular output directory, create a configuration file such as this one

{
    "output_dir": "../top-github-users-data",
    "city" : "Granada",
	"exclude": "El Granada",
    "layout": "granada.ect"
}

exclude is a regular expression for excluding certain patterns in the location field; those users will be excluded from the files.

With that configuration file called granada.json, generate a ranking using

# Generate data
./get-city.coffee granada

If there is not such configuration file, the general config.json is used, and you can generate the ranking with

./get-city.coffee Málaga

License

The MIT License (MIT)

Copyright (c) 2013,2014 Paul Miller (http://paulmillr.com/) JJ Merelo (http://jj.github.io)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.