/stargazer

Your repo reached a stars milestone? Celebrate with a video of your stargazers!

Primary LanguageTypeScript

Your repo reached a stars milestone? Celebrate with a video of your stargazers!

Example

out.mp4

There are 2 ways to make your Stargazer video.

  1. Make your Video locally
  2. Make your Video using Github Actions (Easy)

Make your own video (local)

  1. Use this repo as a template

  2. Go to https://github.com/settings/personal-access-tokens/new and create a token with default settings. Create a .env file and add it:

REMOTION_GITHUB_TOKEN=github_pat_...
  1. Install dependencies:
npm i
  1. Start the preview:
npm start
  1. Open the right sidebar, enter your repo name and click "Render".

Make your own video (GitHub Actions)

  1. Fork this repo

  1. Go to Actions of the forked repo.

  1. Click on I understand my workforce, go ahead and enable them

  1. Go to the render video option in the workforce.

  1. Over here enter the details of the repo for which you want to make the Stargazer video.

  1. Here you can see the progress of the rendering video.

  1. By clicking on this you can get your Stargazer video.

Credits

Made with Remotion

License

The code in this repository: Licensed under MIT.
The Remotion framework (a dependency of this project): Normally, companies need to obtain a paid license.
However, creating videos of this template is accepted without needing a company license.