Skip to content
Podcast Framework

Development Setup

Development Setup

Section titled “Development Setup”

Set up your local environment for contributing to Podcast Framework.

Prerequisites

Section titled “Prerequisites”
  • Node.js 18+
  • npm 9+
  • Git
  • VS Code (recommended)

Clone Repository

Section titled “Clone Repository”
Terminal window
git clone https://github.com/rejected-media/podcast-framework.git
cd podcast-framework

Install Dependencies

Section titled “Install Dependencies”
Terminal window
npm install

This installs dependencies for all packages in the monorepo.

Repository Structure

Section titled “Repository Structure”
podcast-framework/
├── packages/
│   ├── core/                      # @rejected-media/podcast-framework-core
│   ├── sanity-schema/             # @rejected-media/podcast-framework-sanity-schema
│   ├── cli/                       # @rejected-media/podcast-framework-cli
│   └── create-podcast-framework/  # @rejected-media/create-podcast-framework
├── package.json                   # Monorepo config
└── README.md

Running Tests

Section titled “Running Tests”
Terminal window
# Run all tests
npm test


# Run tests in watch mode
npm run test:watch


# Run tests for specific package
cd packages/core
npm test

Building Packages

Section titled “Building Packages”
Terminal window
# Build all packages
npm run build


# Build specific package
cd packages/core
npm run build

Testing Changes Locally

Section titled “Testing Changes Locally”
Section titled “Link Packages”
Terminal window
# In podcast-framework/packages/core
npm link


# In your test podcast
npm link @rejected-media/podcast-framework-core

Now your test podcast uses your local development version!

Test Workflow

Section titled “Test Workflow”
  1. Make changes in packages/core/
  2. Build: npm run build
  3. Test in linked podcast: npm run dev
  4. Verify changes work
  5. Write tests
  6. Run tests: npm test

Code Style

Section titled “Code Style”

ESLint

Section titled “ESLint”
Terminal window
npm run lint

Prettier

Section titled “Prettier”
Terminal window
npm run format

TypeScript

Section titled “TypeScript”
Terminal window
npm run type-check

VS Code Setup

Section titled “VS Code Setup”
Section titled “Recommended Extensions”
{
  "recommendations": [
    "astro-build.astro-vscode",
    "dbaeumer.vscode-eslint",
    "esbenp.prettier-vscode",
    "bradlc.vscode-tailwindcss"
  ]
}

Settings

Section titled “Settings”
{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "[astro]": {
    "editor.defaultFormatter": "astro-build.astro-vscode"
  },
  "typescript.tsdk": "node_modules/typescript/lib"
}

Running Examples

Section titled “Running Examples”

The template repository serves as an example:

Terminal window
git clone https://github.com/rejected-media/podcast-template.git
cd podcast-template
npm install
npm run dev

Common Tasks

Section titled “Common Tasks”

Add New Component

Section titled “Add New Component”
  1. Create packages/core/src/components/NewComponent.astro
  2. Add tests: packages/core/src/components/NewComponent.test.ts
  3. Export in packages/core/src/index.ts
  4. Build: npm run build
  5. Test: npm test
  6. Document in docs

Add New Utility

Section titled “Add New Utility”
  1. Add to packages/core/src/lib/utils.ts
  2. Add tests: packages/core/src/lib/utils.test.ts
  3. Export in packages/core/src/index.ts
  4. Build and test

Update Schema

Section titled “Update Schema”
  1. Edit packages/sanity-schema/src/schemas/[schema].ts
  2. Add tests
  3. Build and test
  4. Update migration guide if breaking change

Release Process

Section titled “Release Process”

Maintainers only:

Terminal window
# Update version
npm version patch  # or minor, major


# Build
npm run build


# Publish
npm publish

Getting Help

Section titled “Getting Help”
Section titled “Related”

Thank You!

Section titled “Thank You!”

Your contributions make Podcast Framework better for everyone!