Repository files navigation

Try it out live:GitHubUnwrapped.com

A platform that generates a year-in-review video for each GitHub user. Built with Vite 5, Remotion and AWS Lambda.

Want to make your own year-in-review for your users?

Feel free to fork and use this repository as a template! Note the legal disclaimers at the bottom of this README.

• 2024:main branch
• 2023:2023 branch
• 2022:github-unwrapped-2022 Repo
• 2021:github-unwrapped-2021 Repo

1. Runnpm i to install dependencies.

2. Rename.env.example to.env

3. Set up your AWS account according to theRemotion Lambda - Setup guide. We use multiple accounts for load-balancing:

   • UseAWS_KEY_1 instead ofREMOTION_AWS_ACCESS_KEY_ID andAWS_SECRET_1 instead ofREMOTION_AWS_SECRET_ACCESS_KEY.
   • You can useAWS_KEY_2 andAWS_SECRET_2 to load-balance between two accounts, or paste the same credentials as before to use the same account.
   • Insrc/helpers/set-env-for-key.ts, we rotate the environment variables.

4. Deploy the functions into your AWS account(s):

   npx tsx deploy.ts

   Note that some AWS regions are disabled by default.If you get an error, enable them or limit yourself to only default ones.

5. For caching the videos and GitHub API responses, set up a MongoDB (we use a free MongoDB Atlas Cloud instance) to save the videos. Set the connection string by filling out the values in.env.

6. For fetching data from GitHub, create a personal access token in your user settings (no need to grant any scopes, the GraphQL API needs to be authenticated to get public information) and set it asGITHUB_TOKEN_1. Adding more tokensGITHUB_TOKEN_2 etc. will rotate the personal access tokens.

7. ProvideDISCORD_CHANNEL andDISCORD_TOKEN values to send monitoring logs to Discord.

8. Add aSENTRY_DSN environment variable to get error reports.

You now have all environment variables.

Run the web app:

npm run dev

Edit the template in the Remotion Studio:

npm run remotion

To deploy, connect your repository toRender. Don't forget to also set the environment variables there too.

To allow thousands of people to render their video at the same time, we applied multiple strategies for scaling:

• Caching the video whenever possible. Before each render, a MongoDB database lock is created to avoid multiple renders for the same GitHub user to be accidentally created.
• Renders are distributed across an array of AWS regions and accounts to prevent hitting theconcurrency limit.

We thankGitHub andFor One Red for their support in realization and promoting of this project.

The audio was licensed for GitHubUnwrapped.com fromSmartSound. If you create a derivative project, you must contact them for licensing.

The code in this repository: Licensed under MIT.
The Remotion framework (a dependency of this project): Companies need to obtain a paid license. Read the termshere.