@rejected-media/create-podcast-framework
v0.1.11
Published
Scaffolding tool for creating new podcast framework projects
Maintainers
Readme
@rejected-media/create-podcast-framework
Scaffolding tool for creating new podcast framework projects via npm create.
Usage
Create a new project
# Using npm
npm create @rejected-media/podcast-framework my-podcast
# Using npx
npx @rejected-media/create-podcast-framework my-podcast
# Interactive (will prompt for project name)
npm create @rejected-media/podcast-frameworkOptions
All options from @rejected-media/podcast-framework-cli create are supported:
# Skip npm install
npm create @rejected-media/podcast-framework my-podcast --skip-install
# Use specific template
npm create @rejected-media/podcast-framework my-podcast --template advancedWhat It Does
This package is a thin wrapper around @rejected-media/podcast-framework-cli that enables the standard npm create pattern.
When you run npm create @rejected-media/podcast-framework, it:
- Installs this package temporarily
- Executes the wrapper script
- Calls
podcast-framework createwith your arguments - Creates a complete podcast project with:
- Astro project structure
- Sanity CMS configuration
- Framework components and utilities
- Configuration files
- Sample content
What Gets Created
my-podcast/
├── src/
│ ├── pages/
│ │ └── index.astro
│ └── components/
├── public/
├── sanity/
│ └── schemas/
├── package.json
├── podcast.config.js
├── astro.config.mjs
├── .env.template
└── README.mdNext Steps After Creation
- Navigate to your project:
cd my-podcast - Install dependencies:
npm install - Set up Sanity CMS at https://sanity.io/manage
- Copy
.env.templateto.env.local - Add your Sanity project ID and credentials
- Start development:
npm run dev
Documentation
How It Works
This package implements npm's npm create pattern:
npm create foo→ Runsnpx create-foonpm create @scope/foo→ Runsnpx @scope/create-foo
So npm create @rejected-media/podcast-framework runs npx @rejected-media/create-podcast-framework, which invokes the CLI's create command.
For Developers
Local Development
# Install dependencies
npm install
# Build the package
npm run build
# Test locally
npm link
cd /tmp
npm create @rejected-media/podcast-framework test-projectPublishing
# Build first
npm run build
# Publish to npm
npm publishThe prepublishOnly script automatically runs npm run build before publishing.
License
MIT - see LICENSE
Related Packages
- @rejected-media/podcast-framework-cli - Full CLI tool with all commands
- @rejected-media/podcast-framework-core - Core components and utilities
- @rejected-media/podcast-framework-sanity-schema - Sanity CMS schemas
