cherylz / castalleys

A Simple and Clean Podcast Player.

Home Page:https://castalleys.com

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CastAlleys — A Simple and Clean Podcast Player

castalleys.com

Screenshot of CastAlleys

Scores by Google Lighthouse:

Scores by Google Lighthouse

Table of Contents

What Users Can Do with CastAlleys

Technologies

Installation

Credits

Inspirations

Get Support

Behind the Scenes

What Users Can Do with CastAlleys

Just search for what you want to listen to and you are ready to play the show. You can use it on your phone without having to download an extra app since it's a progressive web app. To add some fun when enjoying its simplicity, you can choose what color you want the app in.

Technologies

Installation

  • Run npm install to install all the dependencies.
  • Get your freemium X-ListenAPI-Key from https://www.listennotes.com/api/ to be able to call the podcast search API.
  • Create a file named apiKey.js in the src folder. Paste this line export const apiKey = "key"; into the file and replace the string key with your key grabbed from the previous step.
  • Run npm start to make edits in the development mode.

Credits

There are many free resources that helped me learn new things and solve problems for building this project, as well as the paid resources. Below are my thanks to some of the free resource providers.

If you are reading this and you are learning to code, I hope the info below can save you some time of searching for free and good resources. Shoot me an email if you want to know about the paid resources.

Thank you,

Inspirations

The navigation bar is inspired by Patagonia. The homepage cover image is inspired by Spotify.

Get Support

If you have questions on how to get the app up and running or want to say hi, please shoot me an email.

Behind the Scenes

Why I Built CastAlleys

CastAlleys was built as a capstone project for an online coding bootcamp (Altcademy) I enrolled. My goals for this project were to build something at least I would use (I like podcasts) and something that I could practice what I had learned with and challenged me to learn more.

User Stories

  • Some podcast listeners who use computers more often than mobile phones want to search and play a show directly from their computer, without the need to take out their phone, unlock the screen and open an app. They will find CastAlleys handy to use since it is optimized for web users.
  • There are also podcast listeners who want to keep their mobile apps to the minimum. They can use CastAlleys on their phone's home screen without downloading it since it is a progressive web app.

Main Features

  • Search:
    • Podcast search
    • Episode search with matched keyword(s) highlighted in titles, descriptions and transcripts
    • Episode search within a given podcast
  • Podcast streaming with playback controls
  • Star a podcast
  • Like an episode
  • Track play history
  • Customizable theme color

Wireframes

In case you are interested in checking out wireframes, here are the initial drafts I made with pen and paper for large screens: link. For wireframes of small screens and design changes, I coded them without sketches.

General Approach

Planning

  • Steps: generate the idea, plan for the scope of work and timeline, decide on the art direction, make wireframes for critical pages, plan for the component hierarchy in React, and set up the file structure based on the hierarchy.

Building

  • Major steps: Build a static version. Then move on to build an interactive version by adding features one at a time.
  • For each major step, repeat the process of 'build, test, deploy, commit to GitHub'.

Quality

About

A Simple and Clean Podcast Player.

https://castalleys.com


Languages

Language:JavaScript 81.2%Language:CSS 16.6%Language:HTML 2.1%