lipis / github-stats

GitHub Stats

GitHub Stats is just a fun project based on gae-init

Requirements

• Google App Engine SDK for Python
• Node.js, Yarn, pip, virtualenv
• macOS or Linux or Windows

Make sure you have all of the above or refer to the docs on how to install the requirements.

Running the Development Environment

cd /path/to/github-stats
gulp

To test it visit http://localhost:3000 in your browser.

For a complete list of commands:

gulp help

Initializing or Resetting the project

cd /path/to/github-stats
npm install
gulp

If something goes wrong you can always do:

gulp reset
yarn
gulp

To install Gulp as a global package:

yarn global add gulp-cli

Local testing

If you wish to run an automated test script, there is an additional dependency which can be installed with:

pip install -r test-requirements.txt

A simple test script framework, following the approach from the Google App Engine docs, can be run:

python main/runner.py --test-path tests ${HOME}/google-cloud-sdk/

This simply tests that the site can start up; that the index page exists (and returns an http response code of 200), and that a non-existent page returns an http response code of 404.

The test framework is easily extensible.

Deploying on Google App Engine

gulp deploy
gulp deploy --project=foo
gulp deploy --project=foo --version=bar
gulp deploy --project=foo --version=bar --no-promote

Tech Stack

• Google App Engine, NDB
• Jinja2, Flask, Flask-RESTful, Flask-WTF
• Less
• Bootstrap, Font Awesome, Social Buttons
• jQuery, Moment.js
• OpenID sign in (Google, Facebook, Twitter and more)
• Python 2.7, pip, virtualenv
• Gulp, Bower