{"id":13479157,"url":"https://github.com/remotion-dev/github-unwrapped-2022","last_synced_at":"2025-05-16T07:07:05.154Z","repository":{"id":64951245,"uuid":"568064785","full_name":"remotion-dev/github-unwrapped-2022","owner":"remotion-dev","description":"Your coding year in review #GitHubUnwrapped","archived":false,"fork":false,"pushed_at":"2023-04-04T06:53:57.000Z","size":35243,"stargazers_count":1318,"open_issues_count":1,"forks_count":76,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-04-08T17:17:34.741Z","etag":null,"topics":["github","react","remotion"],"latest_commit_sha":null,"homepage":"https://GitHubUnwrapped.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/remotion-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2022-11-19T10:43:06.000Z","updated_at":"2025-03-20T13:05:26.000Z","dependencies_parsed_at":"2024-01-15T16:45:09.864Z","dependency_job_id":null,"html_url":"https://github.com/remotion-dev/github-unwrapped-2022","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remotion-dev%2Fgithub-unwrapped-2022","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remotion-dev%2Fgithub-unwrapped-2022/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remotion-dev%2Fgithub-unwrapped-2022/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/remotion-dev%2Fgithub-unwrapped-2022/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/remotion-dev","download_url":"https://codeload.github.com/remotion-dev/github-unwrapped-2022/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254485065,"owners_count":22078767,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github","react","remotion"],"created_at":"2024-07-31T16:02:10.527Z","updated_at":"2025-05-16T07:07:00.140Z","avatar_url":"https://github.com/remotion-dev.png","language":"TypeScript","readme":"\u003cimg src=\"public/promo1.png\"\u003e\n\u003cimg src=\"public/promo2.png\"\u003e\n\n**Try it out live:** [GitHubUnwrapped.com](https://www.githubunwrapped.com)\n\nA platform that generates a year in review video for each GitHub user. Built with Next.JS, Remotion and AWS Lambda.\n\n## Make your own\n\nWant to make your own year in review for your users?\n\n- **Developers**: Feel free to fork use this repository as a template! Note the legal disclaimers at the bottom of this README.\n- **Non-developers**: Write to [hi@remotion.dev](mailto:hi@remotion.dev) for a free consultation in Fall 2023!\n\n## Setup\n\n1. Run `npm i` to install dependencies.\n2. Rename `.env.example` to `.env`\n3. Set up your AWS account according to the [Remotion Lambda Setup guide](https://remotion.dev/docs/lambda/setup). We use multiple accounts for load-balancing:\n   - Use `AWS_KEY_1` instead of `REMOTION_AWS_ACCESS_KEY_ID` and `AWS_SECRET_1` instead of `REMOTION_AWS_SECRET_ACCESS_KEY`.\n   - You can use `AWS_KEY_2` and `AWS_SECRET_2` to load-balance between two accounts, or paste the same credentials as before to use the same account.\n   - In `src/set-env-for-key.ts`, we rotate the environment variables.\n4. Deploy the functions into your AWS account(s):\n   ```\n   npx ts-node deploy.ts\n   ```\n   \n   Note that some AWS regions are disabled by default. [If you get an error, enable them or limit yourself to only default ones.](https://remotion.dev/docs/lambda/troubleshooting/security-token)\n5. 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 as `MONGO_URL`.\n6. 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 as `GITHUB_TOKEN_1`. Adding more tokens `GITHUB_TOKEN_2` etc. will rotate the personal access tokens.\n7. Optionally, provide `DISCORD_CHANNEL` and `DISCORD_TOKEN` values to send monitoring logs to Discord.\n\nYou now have all environment variables.\n\nRun the web app:\n\n```console\nnpm run dev\n```\n\nEdit the template in the Remotion preview:\n\n```console\nnpm run preview\n```\n\nTo deploy, connect your repository to Vercel.\n\nDon't forget to also set the environment variables there too.\n\n## Scaling strategy\n\nTo allow thousands of people to render their video at the same time, we applied multiple strategies for scaling:\n\n- 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.\n- Renders are distributed across an array of AWS regions and accounts to avoid hitting the [concurrency limit](https://www.remotion.dev/docs/lambda/troubleshooting/rate-limit).\n\n## Credits\n\nWe thank GitHub for their support in realization and promotion of this project.\n\n## Music copyright disclaimer\n\nThe music was licensed for GitHubUnwrapped.com specifically. If you create a derivative project, you may not use it.\n\n## License\n\nThe code in this repository: Licensed under MIT.  \nThe Remotion framework (a dependency of this project): Companies need to obtain a paid license. Read the terms [here](https://github.com/remotion-dev/remotion/blob/main/LICENSE.md#company-license).\n","funding_links":[],"categories":["TypeScript","🛠️ Widgets 👇"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremotion-dev%2Fgithub-unwrapped-2022","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fremotion-dev%2Fgithub-unwrapped-2022","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fremotion-dev%2Fgithub-unwrapped-2022/lists"}