https://github.com/podverse/podverse-api
Data API, database migration scripts, and backend services for all Podverse apps
https://github.com/podverse/podverse-api
agplv3 foss hacktoberfest libre open-source podcast podcasting podcasting20 podcasts rss v4v valueforvalue
Last synced: 24 days ago
JSON representation
Data API, database migration scripts, and backend services for all Podverse apps
- Host: GitHub
- URL: https://github.com/podverse/podverse-api
- Owner: podverse
- License: agpl-3.0
- Created: 2018-09-03T23:32:34.000Z (almost 7 years ago)
- Default Branch: develop
- Last Pushed: 2024-04-29T03:43:35.000Z (about 1 year ago)
- Last Synced: 2024-05-01T11:37:02.027Z (about 1 year ago)
- Topics: agplv3, foss, hacktoberfest, libre, open-source, podcast, podcasting, podcasting20, podcasts, rss, v4v, valueforvalue
- Language: TypeScript
- Homepage: https://podverse.fm/about
- Size: 273 MB
- Stars: 24
- Watchers: 6
- Forks: 15
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# podverse-api
Data API, database migration scripts, and backend services for the Podverse ecosystem
- [Getting started](#getting-started)
* [NPM or Yarn](#npm-or-yarn)
* [Setup environment variables](#setup-environment-variables)
* [Install node_modules](#install-node-modules)
* [Start dev server](#start-dev-server)
* [Populate database](#populate-database)
* [Add podcast categories to the database](#add-podcast-categories-to-the-database)
* [Sync podcast data with Podcast Index API](#sync-podcast-data-with-podcast-index-api)
* [Matomo page tracking and analytics](#matomo-page-tracking-and-analytics)
* [More info](#more-info)
## Getting started
If you are looking to run this app or contribute to Podverse for the first time, please read the sections that are relevant for you in our [CONTRIBUTE.md](https://github.com/podverse/podverse-ops/blob/master/CONTRIBUTING.md) file in the podverse-ops repo. Among other things, that file contains instructions for running a local instance of the Podverse database.
### NPM or Yarn
We use yarn and maintain a `yarn.lock` file, but it's not really a requirement for you to use yarn. This documentation uses npm in examples, but we generally use the yarn equivalent commands.
### Setup environment variables
For local development, environment variables are provided by a local `.env` file. You can find a link to example `.env` files in the [CONTRIBUTING.md](https://github.com/podverse/podverse-ops/blob/master/CONTRIBUTING.md) file.
### Install node_modules
```bash
npm install
```
### Start dev server
```bash
npm run dev
```
### Populate database
Instructions for this can be found in the [podverse-ops CONTRIBUTING.md file](https://github.com/podverse/podverse-ops/blob/master/CONTRIBUTING.md).
### Add podcast categories to the database
If you are creating a database from scratch, and not using the `populateDatabase` command explained in the CONTRIBUTE.md file, then you will need to populate the database with categories.
```bash
npm run dev:seeds:categories
```
### Sync podcast data with Podcast Index API
Podverse maintains its own podcast directory, and parses RSS feeds to populate it with data.
However, in prod Podverse syncs its database with the [Podcast Index API](https://podcastindex.org/), the world's largest open podcast directory, and the maintainers of the "Podcasting 2.0" RSS spec.
We run scripts in a cron interval that request from PI API a list of all the podcasts that it has detected updates in over the past X minutes, and then add those podcast IDs to an Amazon SQS queue for parsing, and then our parser containers, which run continuously, pull items from the queue, run our parser logic over it, then save the parsed data to our database.
If you'd like to run your own full instance of Podverse and would like a thorough explanation of the processes involved, please contact us and we can document it.
### Matomo page tracking and analytics
TODO: explain the Matomo setup
### More info
We used to have a more detailed README file, but I removed most of the content, since it is unnecessary for most local development workflows, and the information it was getting out-of-date. If you're looking for more info though, you can try digging through our [old README file here](https://github.com/podverse/podverse-api/blob/develop/docs/old/old-readme.md).