mirror of
https://github.com/algora-io/tv.git
synced 2025-02-14 01:59:50 +02:00
109 lines
2.4 KiB
Markdown
109 lines
2.4 KiB
Markdown
|
<!-- PROJECT LOGO -->
|
||
|
|
<p align="center">
|
||
|
|
<a href="https://github.com/algora-io/tv">
|
||
|
|
<img src="https://user-images.githubusercontent.com/17045339/231901505-2936b331-3716-4418-9386-4a5d9cb694ba.svg" alt="Logo">
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<h3 align="center">Algora TV</h3>
|
||
|
|
|
||
|
|
<p align="center">
|
||
|
|
The interactive livestreaming & video sharing service for developers.
|
||
|
|
<br />
|
||
|
|
<a href="https://tv.algora.io">Website</a>
|
||
|
|
·
|
||
|
|
<a href="https://algora.io/discord">Discord</a>
|
||
|
|
·
|
||
|
|
<a href="https://twitter.com/algoraio">Twitter</a>
|
||
|
|
·
|
||
|
|
<a href="https://www.youtube.com/@algora-io">YouTube</a>
|
||
|
|
·
|
||
|
|
<a href="https://github.com/algora-io/tv/issues">Issues</a>
|
||
|
|
</p>
|
||
|
|
</p>
|
||
|
|
|
||
|
|
## Architecture
|
||
|
|
|
||
|
|
```mermaid
|
||
|
|
graph
|
||
|
|
Streamer{Streamer} --> Fly
|
||
|
|
Fly[Elixir App - Fly] --> RTMP
|
||
|
|
Fly --> Web[Web Server - Phoenix]
|
||
|
|
Fly --> Db[Postgres - Fly]
|
||
|
|
RTMP[RTMP Server - Membrane] -->|First mile delivery| Tigris[Object Storage - Tigris]
|
||
|
|
Viewers{Viewers} -->|Last mile delivery| Tigris
|
||
|
|
Viewers --> Fly
|
||
|
|
```
|
||
|
|
|
||
|
|
<!-- GETTING STARTED -->
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
To get a local copy up and running, please follow these steps.
|
||
|
|
|
||
|
|
### Prerequisites
|
||
|
|
|
||
|
|
Here is what you need to be able to run Algora TV.
|
||
|
|
|
||
|
|
- Elixir (Version: >=1.12)
|
||
|
|
- OTP
|
||
|
|
- PostgreSQL
|
||
|
|
|
||
|
|
## Development
|
||
|
|
|
||
|
|
### Setup
|
||
|
|
|
||
|
|
1. Clone the repo into a public GitHub repository (or fork https://github.com/algora-io/tv/fork).
|
||
|
|
|
||
|
|
```sh
|
||
|
|
git clone https://github.com/algora-io/tv.git
|
||
|
|
```
|
||
|
|
|
||
|
|
2. Go to the project folder
|
||
|
|
|
||
|
|
```sh
|
||
|
|
cd tv
|
||
|
|
```
|
||
|
|
|
||
|
|
3. Install dependencies with mix
|
||
|
|
|
||
|
|
```sh
|
||
|
|
mix deps.get
|
||
|
|
```
|
||
|
|
|
||
|
|
4. Set up your `.env` file
|
||
|
|
|
||
|
|
- Duplicate `.env.example` to `.env`
|
||
|
|
- Add your environment variables in the `.env` file
|
||
|
|
|
||
|
|
5. Create and migrate your database with mix
|
||
|
|
|
||
|
|
```sh
|
||
|
|
mix ecto.setup
|
||
|
|
```
|
||
|
|
|
||
|
|
6. Start your development server
|
||
|
|
|
||
|
|
```sh
|
||
|
|
env $(cat .env | xargs -L 1) iex -S mix phx.server
|
||
|
|
```
|
||
|
|
|
||
|
|
<!-- LICENSE -->
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Distributed under the [AGPLv3 License](https://github.com/algora-io/tv/blob/main/LICENSE). See `LICENSE` for more information.
|
||
|
|
|
||
|
|
<!-- ACKNOWLEDGEMENTS -->
|
||
|
|
|
||
|
|
## Acknowledgements
|
||
|
|
|
||
|
|
Special thanks to these amazing projects which help power Algora TV:
|
||
|
|
|
||
|
|
- [Tigris](https://www.tigrisdata.com/)
|
||
|
|
- [Fly.io](https://fly.io/)
|
||
|
|
- [Phoenix Framework](https://www.phoenixframework.org/)
|
||
|
|
- [Ecto](https://github.com/elixir-ecto/ecto)
|
||
|
|
- [Membrane](https://membrane.stream/)
|
||
|
|
- [FFmpeg](https://ffmpeg.org/)
|
||
|
|
- [Tailwind CSS](https://tailwindcss.com/)
|