@@ -51,24 +46,25 @@ Report Bug · Request Feature + · + Screenshots
- - -## Table of Contents -* [About the Project](#about-the-project) - * [Motivation](#motivation) - * [Built With](#built-with) -* [Installation](#installation) -* [License](#license) -* [Roadmap](#roadmap) -* [Contact](#contact) +## Table of Contents +- [About the Project](#about-the-project) + - [Motivation](#motivation) + - [Built With](#built-with) +- [Installation](#installation) +- [License](#license) +- [Roadmap](#roadmap) +- [Contact](#contact) + ## About The Project Podgrab is a is a self-hosted podcast manager which automatically downloads latest podcast episodes. It is a light-weight application built using GO. @@ -79,29 +75,30 @@ It works best if you already know which podcasts you want to monitor. However th Podgrab started a tool that I initially built to solve a specific problem I had. During the COVID pandemic times I started going for a run. I do not prefer taking by phone along so I would add podcast episodes to my smart watch which could be connected with my bluetooth earphones. Most podcasting apps do not expose the mp3 files directly which is why I decided to build this quick tool for myself. Once it reached a stage where my requirements were fulfilled I decided to make it a little pretty and share it with everyone else. - ![Product Name Screen Shot][product-screenshot] - +[More Screenshots](Screenshots.md) ### Built With -* [Go](https://golang.org/) -* [Go-Gin](https://github.com/gin-gonic/gin) -* [GORM](https://github.com/go-gorm/gorm) -* [SQLite](https://www.sqlite.org/index.html) +- [Go](https://golang.org/) +- [Go-Gin](https://github.com/gin-gonic/gin) +- [GORM](https://github.com/go-gorm/gorm) +- [SQLite](https://www.sqlite.org/index.html) ## Installation -The easiest way to run Podgrab is to run it as a docker container. +The easiest way to run Podgrab is to run it as a docker container. ### Using Docker Simple setup without mounted volumes (for testing and evaluation) + ```sh docker run -d -p 8080:8080 --name=podgrab akhilrex/podgrab ``` Binding local volumes to the container + ```sh docker run -d -p 8080:8080 --name=podgrab -v "/host/path/to/assets:/assets" -v "/host/path/to/config:/config" akhilrex/podgrab ``` @@ -109,6 +106,7 @@ Binding local volumes to the container ### Using Docker-Compose Modify the docker compose file provided [here](https://github.com/akhilrex/podgrab/blob/master/docker-compose.yml) to update the volume and port binding and run the following command + ```yaml version: "2.1" services: @@ -131,23 +129,26 @@ services: ### Environment Variables -| Name | Description | Default | -| --- | --- | --- | -| CHECK_FREQUENCY | How frequently to check for new episodes and missing files (in minutes) | 30 | - +| Name | Description | Default | +| --------------- | ----------------------------------------------------------------------- | ------- | +| CHECK_FREQUENCY | How frequently to check for new episodes and missing files (in minutes) | 30 | + ## License Distributed under the MIT License. See `LICENSE` for more information. ## Roadmap + Following are the things that I plan to complete in the near future. + - Some more code refactoring. - API standardisation so that it can be used to build apps on top of it. - Better search and discovery + ## Contact Akhil Gupta - [@akhilrex](https://twitter.com/akhilrex) @@ -156,10 +157,9 @@ Project Link: [https://github.com/akhilrex/podgrab](https://github.com/akhilrex/
-
-
+
[contributors-shield]: https://img.shields.io/github/contributors/akhilrex/podgrab.svg?style=flat-square
[contributors-url]: https://github.com/akhilrex/podgrab/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/akhilrex/podgrab.svg?style=flat-square
diff --git a/Screenshots.md b/Screenshots.md
new file mode 100644
index 0000000..f72a04b
--- /dev/null
+++ b/Screenshots.md
@@ -0,0 +1,21 @@
+## Home Page / Podcast Listing
+
+![Product Name Screen Shot][product-screenshot]
+
+## Add Podcast
+
+
+
+## All Episodes Chronologically
+
+
+
+## Podcast Episodes
+
+
+
+## Settings
+
+
+
+[product-screenshot]: images/screenshot.jpg
diff --git a/images/add_podcast.jpg b/images/add_podcast.jpg
new file mode 100644
index 0000000..03c0baf
Binary files /dev/null and b/images/add_podcast.jpg differ
diff --git a/images/all_episodes.jpg b/images/all_episodes.jpg
new file mode 100644
index 0000000..ab25784
Binary files /dev/null and b/images/all_episodes.jpg differ
diff --git a/images/podcast_episodes.jpg b/images/podcast_episodes.jpg
new file mode 100644
index 0000000..5fb84ff
Binary files /dev/null and b/images/podcast_episodes.jpg differ
diff --git a/images/screenshot.jpg b/images/screenshot.jpg
index a97f86d..93a0104 100644
Binary files a/images/screenshot.jpg and b/images/screenshot.jpg differ
diff --git a/images/screenshot_1.jpg b/images/screenshot_1.jpg
new file mode 100644
index 0000000..a97f86d
Binary files /dev/null and b/images/screenshot_1.jpg differ
diff --git a/images/settings.jpg b/images/settings.jpg
new file mode 100644
index 0000000..0f50f2e
Binary files /dev/null and b/images/settings.jpg differ