Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/manuelernestog/astropod
Free and open source self-hosting serverless podcast solution
https://github.com/manuelernestog/astropod
astro podcast podcasting self-hosted serverless
Last synced: about 1 month ago
JSON representation
Free and open source self-hosting serverless podcast solution
- Host: GitHub
- URL: https://github.com/manuelernestog/astropod
- Owner: manuelernestog
- License: mit
- Created: 2023-08-09T15:31:53.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-06T14:20:55.000Z (7 months ago)
- Last Synced: 2024-09-30T17:23:44.798Z (about 1 month ago)
- Topics: astro, podcast, podcasting, self-hosted, serverless
- Language: Astro
- Homepage: https://getastropod.netlify.app/
- Size: 8.69 MB
- Stars: 127
- Watchers: 4
- Forks: 40
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Astropod | Free and Open Source Serverless Podcast
Astropod is a free and open-source self-hosting serverless podcast solution. It supports diverse deployment services and audio hosting options and includes a customizable website deployable in a few clicks, with a personalized domain and a user-friendly CMS for effortless podcast management.
---
## Demo and Tutorial
View a live demo and a tutorial step by step of how deploy and configure your podcast with Astropod.
👉️
---
## Quick deploy
[][deploy]
- Click the Deploy button to copy this project to your own GitHub or GitLab account and deploy your podcast with Netlify in minutes. ✨
- Once you’ve got the project set up, you do need to
[activate Netlify Identity in the Netlify UI][identity], the
[“Git Gateway”][gateway] to allow e-mail/password authentication and you are ready to go.
---
## Deployment Services
Astropod is build in the top of [Astro](https://astro.build/) framework and is ready to be deployed in the deployments services like GitHub Pages, Netlify, Vercel, Cloudflare, AWS and much more.
The configuration for the deployment varies depending on the platform where you are going to do it. See the [official Astro information](https://docs.astro.build/en/guides/deploy/) to deploy your website.
## File storage
Astropod is designed to work with any file storage solution.
You can host your podcast files in your own code base inside the folder `public/audio` and this will automatically work with [git LFS](https://git-lfs.com/) but free plans in GitHub and GitLab for LFS are limited so take that in mind.
You can also host your podcast files in any other cloud storage solution like DropBox, Google Drive, Cloudinary or on your own server. Once you upload your audio file you just need to copy the public URL of the audio file into your episode `AudioUrl` field.
For free unlimited cloud file storage we recommend use [Internet Archive](https://archive.org/).
## Content Management System
Astropod is designed in such a way that you can use it directly from the source code by editing the configuration files found in the `/.astropod` folder and modifying the episode markdown files contained in the folder `/src/content/episode`.
In order to manage podcast in a simpler way, astropod is configured by default with the CMS Serverless [Decap](https://decapcms.org/) which allows collaborative work, authentication with email or other providers and simple management.
For the easiest use of Decap we recommend deploying Astropod on Netlify since the authentication system is integrated into the platform and is configured natively. If you would like to facilitate your own OAuth authentication rather than use Netlify's service or a client side flow like implicit or PKCE, you can use one of this [community-maintained projects](https://decapcms.org/docs/external-oauth-clients/).
The fact that Astropod comes configured by default with Decap does not mean that it is the only CMS with which it can work, if you prefer to use another CMS like Sanity, Wordpress, Strapi, Tina, or any other you can follow [Astro's integration guides](https://docs.astro.build/en/guides/cms/) to your integrate your favorite CMS.
## Tech Stack
- [Astro](https://astro.build)
- [Tailwind](https://tailwindcss.com/)
- [DaisyUI](https://daisyui.com/)
## Requirements
- Node 16.16.0 or higher
## Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :----------------- | :------------------------------------------------- |
| `pnpm install` | Installs dependencies |
| `pnpm run dev` | Starts local dev & Netlify CMS proxy servers |
| `pnpm run build` | Build your production site to `./dist/` |
| `pnpm run preview` | Serve `./dist/` & run the Netlify CMS proxy server |
> These commands are using [`pnpm`][pnpm], but you can choose to use `npm` or `yarn` instead if you prefer.
## Project Structure
```txt
├── src/
│ ├── components/ // UI components
│ ├── content/
│ │ ├── episode/ // Podcast episodes folder
│ ├── layouts/ // UI Layouts
│ ├── helpers/ // App helpers like static data or functions
│ └── pages/
│ │ ├── rss.xml.js/ // Feed RSS generation file
├── public/ // Public folder dor media files
│ ├── audio/ // Git LFS folder for audio storage
├── .astropod/ // Astropod config files folder
├── astro.config.mjs // Astro config file
├── decap.config.mjs // Decap CMS config file
```
## Contributing
Suggestions and pull requests are welcomed! Feel free to open a discussion or an issue for a new feature request or bug.
One of the best ways of contribute is to grab a [bug report or feature suggestion](https://github.com/manuelernestog/astropod/issues) that has been marked `accepted` and dig in.
Please be wary of working on issues _not_ marked as `accepted`. Just because someone has created an issue doesn't mean we'll accept a pull request for it.
## License
Astropod is licensed under the MIT license — see the [LICENSE](https://github.com/manuelernestog/astropod/blob/main/LICENSE) file for details.
## Contributors
[](https://github.com/manuelernestog/astropod/graphs/contributors)
Made with [contrib.rocks](https://contrib.rocks).
[deploy]: https://app.netlify.com/start/deploy?repository=https://github.com/manuelernestog/astropod
[identity]: https://docs.netlify.com/visitor-access/identity/
[gateway]: https://docs.netlify.com/visitor-access/git-gateway/
[pnpm]: https://pnpm.io/