cecil/staticast

The easiest way to diffuse your podcast

Fund package maintenance!
ArnaudLigny
Open Collective

Installs: 4

Dependents: 0

Suggesters: 0

Security: 0

Stars: 12

Watchers: 2

Forks: 3

Open Issues: 1

Language:CSS

Type:project

2.0.0 2024-01-04 14:41 UTC

This package is auto-updated.

Last update: 2024-10-17 20:32:09 UTC


README

Staticast is a ready to use Progressive Web App to publish your podcast, with a RSS feed ready for syndication platforms, and a user friendly CMS.

Staticast screenshot

Installation

Manually

Staticast is a website generated by Cecil, so you need to download and run Cecil to build your website, then you can publish it where you want.

  1. Be sure PHP (>=8.1) is available on your OS
  2. Download Staticast and install themes with composer install or run composer create-project cecil/staticast myproject
  3. Download cecil.phar and move it to the root of Staticast

Automatically

Use the button to get your own copy of the repository on Netlify.

Deploy to Netlify

This will setup everything needed for running your website, with a CMS:

  • A new repository in your GitHub account
  • Continuous Deployment to Netlify's CDN
  • Control users and access with Netlify Identity
  • Manage content with Netlify CMS

Usage

Create a new episode

  1. Add the MP3 file in assets directory
  2. Create a new Markdown file in pages/episodes

Example (1.md):

---
title: "Episode #1"
episode:
  file: episode-1.mp3
---
Short description of the episode.
<!-- break -->
Notes of the episode.

Refer to Podcast component theme for advanced options.

Preview

Run the following command:

php cecil.phar serve --open

Publish

  1. Run php cecil.phar build
  2. Copy _site folder to your web server

Configuration

Edit the config.yml file, and more precisely the podcast section.

For details, please refer to the Cecil documentation.

Development

Staticast use Tailwind CSS so you can customize the stylesheet with the following files:

# install
composer install
npm install
# build CSS
npx tailwindcss -i ./assets/tailwind.css -o ./assets/styles.css --watch
# serve
php cecil.phar serve -v --config=config/dev.yml

License

Staticast is a free software distributed under the terms of the MIT license.

© Arnaud Ligny