https://github.com/podstation/podstation
podStation is a web podcast aggregator for Chrome.
https://github.com/podstation/podstation
addon chrome chrome-extension chrome-extensions extension javascript lightning-network podcast podcast-aggregator podcasting20 podcasts
Last synced: about 1 month ago
JSON representation
podStation is a web podcast aggregator for Chrome.
- Host: GitHub
- URL: https://github.com/podstation/podstation
- Owner: podStation
- License: mit
- Created: 2016-05-01T18:34:32.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-05-31T08:09:27.000Z (12 months ago)
- Last Synced: 2025-04-10T03:52:29.489Z (about 1 month ago)
- Topics: addon, chrome, chrome-extension, chrome-extensions, extension, javascript, lightning-network, podcast, podcast-aggregator, podcasting20, podcasts
- Language: JavaScript
- Homepage: http://podstation.github.io
- Size: 2.08 MB
- Stars: 159
- Watchers: 12
- Forks: 36
- Open Issues: 168
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# podStation Chrome Extension
[](https://app.travis-ci.com/podStation/podStation)
## About
**podStation** is a free/libre and open-source (FLOSS) podcast aggregator and player for Chrome and other compatible browsers.
It is distributed as a browser extension (see https://en.wikipedia.org/wiki/Browser_extension), but it behaves essentially like a standalone app that uses the browser as a platform.
### Chrome Web Store
[][at-chrome-web-store]
[][at-chrome-web-store]
[][at-chrome-web-store]
## How to install
You can install it at the [chrome web store][at-chrome-web-store].
Although not officially supported yet (no tests in place), it also works on:
- PC
- Opera (https://www.opera.com/)
- Chromium (I think, https://www.chromium.org/getting-involved/download-chromium)
- Edge (the new one based on chromium, https://www.microsoft.com/en-us/edge)
- Brave (https://brave.com/)
- ~Mobile (it works, but the experience is not nice)~ - used to work, but there is a critical open issue, [#202](https://github.com/podStation/podStation/issues/202)
- Kiwi (Android, https://kiwibrowser.com/)
- Yandex (Android, https://browser.yandex.com/mobile/)
- I tried to install on iOS, but I don't think extensions are supported
If there is any browser not listed above where you use podStation, please let me know.
If you want to request a port for a browser, create an issue here, or send us a mail (see the session _Support and Contact_)
A port to Firefox is part of the long term vision of the project, but not in active development.
## History
Back in the days before I had a good Bluetooth headset, that I now use with all my devices, switching between audio from PCs (at work and at home) to mobile was not the most comfortable thing.
As such, I was searching for a cost effective solution to listen to podcasts on desktop operational systems, and also synchronize the list of podcasts between my home and work PC.
There were solutions on the market, but I was thinking that I could build something myself.
Due to the projects I was working on at the time, I was learning front end development and also how to create chrome extensions.
After some research, I decided that a very cost effective way of keeping my list of podcasts in sync would be to use chrome's sync storage (in the order of Kilobytes) for extensions and chrome apps.
That was how the development of podStation started.
## Vision
podStation has reached a mature state where increments are more typically on the direction of bug fixes, optimizations and reduction of technical debt (see ).
If you would like to see all the proposed enhancements, check the open issues:
* at [github][open-issues-at-github],
* at [bitbucket][open-issues-at-bitbucket].
For an idea of the work in progress, check our [planning project][planning-project].
Some features I consider more important (I will add links to existing issues later):
- Become **podStation Browser Extension**: podStation is currently only available for chrome. Although this most likely address the majority of possible users, I don't like the idea of contributing to _vendor lock-in_. Having a port that works on other browsers would make it easier for our users to choose other browsers, and contribute to the competitiveness of this market
- Reduce the necessary _permissions_ required by podStation
There are also some features that I would like to implement, but they are unlikely to become a reality, as it would be a lot of effort:
- Support _marking episodes as listened_ (history) - not enough Sync Storage space
- Integration with [mygpo](https://github.com/gpodder/mygpo) (http://gpodder.net/)
## Development
### Installing the dependencies
You will need to install [Node.js](https://nodejs.org/en/).
I have recently updated to v14.17.6, but it worked well with v10.15.1 before that.
If you use [nvm](http://nvm.sh/) to manage your node installations, you can install and set the current version of node by navigating to the folder of this repo (after cloning it) and running the commands:
```
nvm install
nvm use
```
After that, install the dependencies with the command:
```
npm install
```
### Running locally
1. Build the extension (for development) with the command:
```
npm start
```
2. Go to chrome's extensions page [chrome://extensions/](chrome://extensions/)
3. Enable the _Developer Mode_
4. Click the button _Load unpacked extension_.
5. Choose the `dist` folder
Voilà!
You should see podStation's icon on chrome's toolbar.
You are now running a local copy of podStation, have fun!
### Automated tests
We use Karma and Jasmine for automated tests.
You can run the tests with the command line `npm test`.
If you want to debug the tests run `npm run test-chrome-debugging` if you just want to run them.
### Documentation
You can find the documentation on the [docs](/docs) folder.
## Podcasting 2.0
podStation is committed to support in its best capacity the new features introduced with with Podcasting 2.0.
Currently it supports:
- search with the [podcastindex.org](https://podcastindex.org) API
- the following tags from the [podcast namespace](https://github.com/Podcastindex-org/podcast-namespace/blob/main/docs/1.0.md)
- `podcast:funding`
- `podcast:value`
- value for value monetization / pledge model using Bitcoin through the [Lightning Network](https://lightning.network/)
Learn more at [Podcasting 2.0](https://github.com/Podcastindex-org/podcast-namespace/blob/main/podcasting2.0.md).
Find more Podcastings 2.0 apps at https://podcastindex.org/apps.
Find Podcasting 2.0 projects on GitHub by looking for the topic [podcasting20](https://github.com/topics/podcasting20).
Find podStation backlog for Podcasting 2.0 by looking for [issues with the label `pc20`](https://github.com/podStation/podStation/issues?q=is%3Aissue+is%3Aopen+label%3Apc20).
## Contributing
If you are interesting in contributing to podStation, take a look at our [contribution documentation](https://github.com/podStation/.github/blob/master/CONTRIBUTING.md).
## Support and Contact
If you would like to report bugs, request new features, ask questions or contact the owners of this project for any general topic, create an issue in any of the platforms below:
* [GitHub](https://github.com/podStation/podStation/issues/new)
* [BitBucket](https://bitbucket.org/dellagustin/podstation_chrome_ext/issues/new)
If you are not sure how to use any of these platforms, or you do not want to communicate in public for any reason, reach us by email at [email protected].
### Get Social
Wanna chat? Here is podStation's accounts on social media (in order of coolness):
- [Mastodon @[email protected]](https://fosstodon.org/@podstation)
- [Twitter @podStation_app](https://twitter.com/podStation_app)
- [Facebook](https://www.facebook.com/podStation)
## Open source podcasting projects
Here are other great open source projects related to podcastings:
- [podcastindex.org](https://github.com/Podcastindex-org)
- [Podfriend](https://github.com/MartinMouritzen/Podfriend) - multiplatform podcast aggregator / player
- [Podlove](https://github.com/podlove) - Podcasting Software & Standards
- [Antennapod](https://github.com/AntennaPod) - android podcast player
## References
- https://en.wikipedia.org/wiki/Free_and_open-source_software
- Browser Extensions Documentation
- https://browserext.github.io/
- Chrome
- [What are extensions](https://developer.chrome.com/extensions)
- [Extension APIs](https://developer.chrome.com/extensions/api_index)
- [Chromium Extensions - Google Group](https://groups.google.com/a/chromium.org/forum/#!forum/chromium-extensions) - Forum
- https://www.w3.org/community/webextensions/
[at-chrome-web-store]: https://chrome.google.com/webstore/detail/podstation/bpcagekijmfcocgjlnnhpdogbplajjfn
[open-issues-at-github]: https://github.com/podStation/podStation/issues
[open-issues-at-bitbucket]: https://bitbucket.org/dellagustin/podstation_chrome_ext/issues?status=new&status=open
[planning-project]: https://github.com/orgs/podStation/projects/1