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

🏆 Create a 3D Printed Model of Your Github Contributions
https://github.com/bcongdon/git-trophy

3d-models 3d-printing aws aws-lambda git github github-api github-contributions react react-app redux shapeways threejs zappa

Last synced: about 3 hours ago
JSON representation

🏆 Create a 3D Printed Model of Your Github Contributions

• Host: GitHub
• URL: https://github.com/bcongdon/git-trophy
• Owner: bcongdon
• License: mit
• Created: 2017-07-13T12:38:06.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-12T09:18:54.000Z (almost 2 years ago)
• Last Synced: 2023-09-08T15:20:11.200Z (about 1 year ago)
• Topics: 3d-models, 3d-printing, aws, aws-lambda, git, github, github-api, github-contributions, react, react-app, redux, shapeways, threejs, zappa
• Language: JavaScript
• Homepage: https://gittrophy.com
• Size: 4.56 MB
• Stars: 83
• Watchers: 2
• Forks: 7
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# git-trophy

🏆 Create a 3D Printed Model of Your Github Contributions

## Demo:

[![demo](assets/demo.gif)](https://gittrophy.com)

## Architecture / Design

GitTrophy uses [React](https://facebook.github.io/react/), [Redux](http://redux.js.org/), [react-three-renderer](https://github.com/toxicFork/react-three-renderer), and [react-semantic-ui](http://react.semantic-ui.com/) on the frontend.

On the backend, GitTrophy has a [Zappa](https://github.com/Miserlou/Zappa/)-powered AWS Lambda API to scrape Github contribution data.

Most information is available on my [blog post](http://benjamincongdon.me/blog/2017/08/11/Building-GitTrophy/) about this project.

## Run it yourself

```bash

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](https://aws.amazon.com/blogs/security/a-new-and-standardized-way-to-manage-credentials-in-the-aws-sdks/)

* 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](https://github.com/bcongdon/git_lambda) - Run [Blender](https://www.blender.org/) in AWS lambda

* [bpy_lambda](https://github.com/bcongdon/bpy_lambda) - Run `git` in a Python lambda subprocess

## Attribution

* Thanks to [Aaron Francis](https://twitter.com/aarondfrancis) for his help in getting contribution stats for repositories (and inspiration via [Commit Print](commitprint.com))!

* Trophy Icon from [NounProject](https://thenounproject.com/search/?q=trophy&i=925612)

* Git Icon from [NounProject](https://thenounproject.com/npbluth/collection/git/?oq=git&cidx=0&i=368567)