👾
Pod Monster

Pod Monster is a mobile-first, web-focused, front-end implementation of many, but not all, of the features specified in new podcast namespace, a.k.a. Podcasting 2.0.

The following documentation is meant for developers trying to run this project. If you're attempting to learn more about Pod Monster itself, please visit the About page.

Getting Started

This is a Next.js project bootstrapped with create-next-app.

1. Install dependencies

   Make sure you're running the version of Node specified in the ~/.nvmrc file (currently "v16") before installing dependencies. This ensures you do not encounter any unexpected package-lock.json file changes. If you use nvm, you can do this with nvm use.

   Then, install dependencies:

   nvm use # if you use nvm
   npm install

2. Setup environment variables at ~/.env.local

   Create a file named ".env.local" at the root of the project with the following contents:

   NEXT_PUBLIC_BASE_URL=http://localhost:3000
   NEXT_PUBLIC_PODCAST_INDEX_API_KEY=
   NEXT_PUBLIC_PODCAST_INDEX_API_SECRET=
   

   Retrieve your Podcast Index API Key and Secret

   You will need to obtain your Podcast Index API Key and Secret from your Podcastindex.org account:

   1. Log in or sign up here.
   2. In the "API Keys" section, click the "+" button to create a new API Key / Secret pair.
   3. You should copy these values down and put them in a safe place as they cannot be retrieved later, but for now it's fine to keep them only in the .env.local file you've created.
   4. Copy and paste the "Key" into the .env.local file, to the right of NEXT_PUBLIC_PODCAST_INDEX_API_KEY=
   5. Copy and paste the "Secret" into the .env.local file, to the right of NEXT_PUBLIC_PODCAST_INDEX_API_SECRET=

   Depending on the characters used in your Key and/or Secret, may need to enclose one of both values inside double-quotes within the ~/.env.local file.

   Example

   NEXT_PUBLIC_BASE_URL=http://localhost:3000
   NEXT_PUBLIC_PODCAST_INDEX_API_KEY=ABC123DEF456GHI789
   NEXT_PUBLIC_PODCAST_INDEX_API_SECRET="A7ndhfE7u#J7s3ud9fF7j8sS7eJiU^evk7yvBF"
   

3. Run the development server

   npm run dev

   Open http://localhost:3000 with your browser to see the result.

Mobile testing

In order to see the development server from your mobile device, you will need your computer's internal IP address.

1. Find your internal IP address and replace the value of NEXT_PUBLIC_BASE_URL in your ~/.env.local file with this IP address.
2. Open the ~/next.config.js file, and add this IP address to the nextConfig.images.domains array. Never check-in this change.
3. Visit the IP address on your phone, adding port :3000 to the end, e.g., 192.168.9.46:3000

Learn More

To learn more about Next.js, the Podcast Index, and other related projects, take a look at the following resources:

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.
• Podcast Index Developer Portal - log in or sign up to access your API Key and Secret.
• Podcast Index API Documentation - documentation for the publicly hosted Podcast Index API.
• The Podcast Namespace - documentation for the podcast namespace specification.