Giter Site home page Giter Site logo

podcast-site's Introduction

Simple Podcast Site

Code Climate Test Coverage Build Status

The aim of this codebase is to provide a simple package for creating a website to host a podcast. At the moment it's specific to FreeTheGeek.fm. But my intent is that over time it can be used by anyone.

How it Works

Here’s how it works. The application’s based around PHP’s Slim framework, along with a series of other components. The intent here is to keep it as light and small as possible, only using and doing what it needs.

For its data source it uses simple text files, which contain a combination of Yaml front matter and a Markdown body as the data source for the content of the site.

The reasons for this approach are:

  • After a quick back of the envelope assessment, the likelihood of having to work with a lot of information at any one time was found to be unlikely
  • Text is easy to retrieve, compress, and cache
  • Text is easily editable regardless of the operating system of choice or the one available
  • Managing content requires only creating, updating, and deleting text files. No special interface is required, minimising the amount of code needed to be created

Yes, if you look in to the code, you’ll see that it is setup to use an adapter-based approach for loading the data. But the intent there was to allow for future growth and change, without spending too much time going down a path which may never come to pass. It was an exercise in disciplined creativity.

Getting Started

Currently, to get started, all you need to do is clone the project and use PHP’s built-in webserver to launch the project locally. You don’t need a dedicated server, as the built-in server should be enough.

However I’m currently working on a Vagrant + Ansible configuration for the project to make it as simple as possible to get started, regardless of what your operating system of choice is and whether you have any or all of the dependencies.

I’m currently reviewing the list of requirements and dependencies and will update composer.json shortly so that it’s clear as to what you need to have on your system for the site to work. But even when that’s done, the list won’t be too long.

## Making Contributions

If you’re keen to make contributions, please feel free. Fork the code, make your change, then submit a PR. I’ll have more in this section shortly.

podcast-site's People

Contributors

maltblue avatar settermjd avatar localheinz avatar

Stargazers

RiverRaid avatar Michael Beckwith avatar Andrew Smith avatar Francesco Napoletano avatar

Watchers

 avatar James Cloos avatar Collins Agbonghama avatar  avatar

podcast-site's Issues

Fix the 404 page

Currently it goes nowhere. Need to implement something half-decent at least.

Fix mobile signup

The button needs to go full width, as does the email input. A class of btn-block will sort it out.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.