pidpod

A friendly podcast player

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

Only node.js and npm or yarn are required for working on the software.

Installing

To get started, install the dependencies in package.json by running the following command

npm install

Available scripts

In the project directory, you can run:

npm start

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any lint errors in the console (both browser and terminal)

npm test

Launches the test runner in the interactive watch mode. There is no DOM mocking(no --env=jsdom) and it is suggested that the tests rather check the custom functionalities than checking if React is working correctly. Note: CI=true is set so that the test suite is run only once

npm run build

Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes. Your app is ready to be deployed!

npm run eject

This project is bootstrapped with create-react-app and hence to eject from the single build configuration, use this command. Note: this is a one-way operation. Once you eject, you can’t go back!

npm run precommit

Note: you'll never have to run this script as husky will run this for you on the precommit git hook

Dependencies

• react: A javascript UI library
• reactDOM: Used to render React to the DOM
• react-scripts: Provided with create-react-app and wraps a lot of dependencies. Dependencies that are used often will be discussed below
  • babel: Transpiler for transpiling modern JS and JSX to plain-old JS.
  • dotenv: Storing environment variables in a secure .env file.
  • eslint: A linting utility for JS and JSX (The lint output is shown on the console upon npm start)
  • jest: Testing platform for javascript software
  • webpack: Bundler and preprocessor for the project
• husky: Utility to run scripts from git hooks
• lint-staged: Enables running scripts on staged git files (This does not work with staged hunks)
• prettier: An opinionated code formatter

License

This project is licensed under the MIT License - see the LICENSE file for details