1
0
mirror of https://github.com/mxpv/podsync.git synced 2024-05-11 05:55:04 +00:00
mxpv-podsync/README.md

41 lines
1.3 KiB
Markdown
Raw Normal View History

2019-07-25 18:02:25 -07:00
# Podsync
![Podsync](docs/img/logo.png)
2019-07-25 17:48:41 -07:00
[![Build Status](https://travis-ci.com/mxpv/podsync.svg?branch=master)](https://travis-ci.com/mxpv/podsync)
2019-07-25 18:02:25 -07:00
[![Go Report Card](https://goreportcard.com/badge/github.com/mxpv/podsync)](https://goreportcard.com/report/github.com/mxpv/podsync)
2019-01-07 21:09:04 -08:00
[![Patreon](https://img.shields.io/badge/support-patreon-E6461A.svg)](https://www.patreon.com/podsync)
2019-07-23 21:26:46 -07:00
Podsync - is a simple, free service that lets you listen to any YouTube / Vimeo channels, playlists or user videos in podcast format.
2019-07-23 21:26:46 -07:00
Podcast applications have a rich functionality for content delivery - automatic download of new episodes, remembering last played position, sync between devices and offline listening. This functionality is not available on YouTube and Vimeo. So the aim of Podsync is to make your life easier and enable you to view/listen to content on any device in podcast client.
2019-07-23 21:26:46 -07:00
## Architecture
2019-07-25 18:02:25 -07:00
![Architecture](docs/img/architecture.png)
2017-08-22 18:57:23 -07:00
2019-01-07 21:09:04 -08:00
## Building Docker images
2017-08-22 18:57:23 -07:00
2019-07-23 21:26:46 -07:00
Every project contains a `Makefile` for building and pushing to a registry:
2017-08-22 18:57:23 -07:00
2019-01-07 21:09:04 -08:00
```bash
2019-07-23 21:26:46 -07:00
make build
make push
make update
2017-08-22 18:57:23 -07:00
```
2017-08-22 22:58:08 -07:00
2019-07-23 21:26:46 -07:00
Use docker-compose to run containers:
2017-08-22 22:58:08 -07:00
2019-01-07 21:09:04 -08:00
```bash
docker-compose pull
docker-compose up -d
```
2019-05-11 11:56:15 -07:00
## Building frontend
Node.js and npm are required in order to build the frontend:
```bash
brew install node
make static
ls -la dist/
```