Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pomber/stargazer

Your repo reached a stars milestone? Celebrate with a video of your stargazers!
https://github.com/pomber/stargazer

github stars video

Last synced: 7 days ago
JSON representation

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

Awesome Lists containing this project

README

        

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

## Example

https://user-images.githubusercontent.com/1911623/121809549-93342a80-cc33-11eb-88ff-e45f8b6dace4.mp4?width=200

## 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](https://github.com/pomber/stargazer/generate)

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_...
```

3. Install dependencies:

```
npm i
```

4. Start the preview:

```
npm run dev
```

5. Open the right sidebar, enter your repo name and click "Render".
Or use the command line:

```
npx remotion render
```

## Make your own video (GitHub Actions)

1. Fork this repo

2. Go to Actions of the forked repo.

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

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

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

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

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

## Upgrade Remotion

```
npx remotion upgrade
```

## Credits

Made with [Remotion](https://www.remotion.dev/)

## 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](https://github.com/pomber/stargazer/issues/19#issuecomment-1868469783) without needing a company license.