Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eladg/ffmpeg-by-example
https://github.com/eladg/ffmpeg-by-example
Last synced: 12 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/eladg/ffmpeg-by-example
- Owner: eladg
- License: cc-by-4.0
- Created: 2021-04-22T23:03:53.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-06T18:52:39.000Z (15 days ago)
- Last Synced: 2025-02-06T19:43:30.479Z (15 days ago)
- Language: HTML
- Size: 4.44 MB
- Stars: 253
- Watchers: 3
- Forks: 15
- Open Issues: 52
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- stars - eladg/ffmpeg-by-example - (HTML)
README
# FFmpeg By Example dot com
[![CC BY 4.0][cc-by-shield]][cc-by] [](https://app.netlify.com/sites/ffmpeg-by-example/deploys)
ffmpegbyexample.com is a documentation website to showcase all unique and different ways to use [FFmpeg](https://ffmpeg.org).
## Contributing
#### Add Your Examples
One of the best and easy ways to contribute to the project is to showcase your ffmpeg script on the site. Send your contribution over at https://ffmpegbyexample.com/contribute
#### Building The Site Locally
The site is staticly generated using [hugo](https://gohugo.io/) and deployed on [netlify](https://www.netlify.com/). The serverless API is based on [Netlify Functions](https://www.netlify.com/products/functions/).
### Initial Configuration
Start by setting `baseURL` and `apiURL` on `config.toml`
```toml
title = "FFmpeg By Example"
baseURL = "https://www.ffmpegbyexample.com" or "http://localhost:1313"
enableRobotsTXT = true
[params]
apiURL = "https://www.ffmpegbyexample.com" or "http://localhost:8888"
```
## Developing
This project has two main components:
### Static Website
The run the static site generator [install hugo](https://gohugo.io/getting-started/installing), and run the following commands:
```shell
$ git clone https://github.com/eladg/ffmpeg-by-example.git
$ cd ffmpeg-by-example
$ hugo server --disableFastRender --port 1313
```
You can now test the site locally by opening your browser at: http://localhost:1313
### Serverless API
To develop & test the Serverless API, install [netlify cli](https://docs.netlify.com/cli/get-started) and run the following commands:
```shell
$ git clone https://github.com/eladg/ffmpeg-by-example.git
$ cd ffmpeg-by-example
$ netlify functions:serve -p 8888
```
You can now test the serverless API locally using something like:
```bash
curl 'http://localhost:8888/.netlify/functions/post_new_example' \
-X POST
--data-raw '{
"id":"JYU1IMXO",
"version": "1.0",
"enabled": true,
"title": "Convert mp4 to aac file",
"description": "A command to convert an mp4 video to aac audio",
"author_name": "Elad Gariany",
"author_email": "[email protected]",
"terminal_command": "ffmpeg -i input.mp4 -vn -c:a aac -q:a 1 output.aac",
"categories": ["audio"],
"tags": ["aac"],
"example_type": "no-preview",
"example_player_data": "",
}'
```
### Deploying / Publishing
the `main` branch is set to auto deploy to https://ffmpeg-by-example.netlify.app for every successful build. Submit your PR to the `main` branch, once approved, it will be release automatically.
## Licensing
This work is licensed under a
[Creative Commons Attribution 4.0 International License][cc-by].
[![CC BY 4.0][cc-by-image]][cc-by]
[cc-by]: http://creativecommons.org/licenses/by/4.0/
[cc-by-image]: https://i.creativecommons.org/l/by/4.0/88x31.png
[cc-by-shield]: https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg