README.md

git-trophy

🏆 Create a 3D Printed Model of Your Github Contributions

Demo:

Architecture / Design

GitTrophy uses React, Redux, react-three-renderer, and react-semantic-ui on the frontend.

On the backend, GitTrophy has a Zappa-powered AWS Lambda API to scrape Github contribution data.

Most information is available on my blog post about this project.

Run it yourself

git clone https://github.com/bcongdon/git-trophy
cd git-trophy

# Start the site
npm i
npm start

# Deploy the lambdas
cd git_trophy_lambda
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
zappa deploy

# Publish the site
cd ..
npm run deploy

This repo isn't necessarily meant to be used to create an independent deployment of git-trophy, but there's nothing stopping you if you want to!

Note: To deploy the backend/frontend you'll have to setup your AWS credentials

• Alternatively, you can run the backend locally with python git_trophy_lambda/app.py
• You'll also need to...
  • edit the lambda URL in src/actions.js (Set BASE_URL to the lambda URL)
  • change the S3 deployment bucket in package.json
  • change the S3 cache bucket in git_trophy_lambda/zappa_settings.json
  • change the Shapeways OAuth clientId in src/oauth.js

Related Projects

• git_lambda - Run Blender in AWS lambda
• bpy_lambda - Run git in a Python lambda subprocess

Attribution

• Thanks to Aaron Francis for his help in getting contribution stats for repositories (and inspiration via Commit Print)!

• Trophy Icon from NounProject

• Git Icon from NounProject