Skip to content

Lombardoc4/TechtonicReadingList

Repository files navigation

Techtonic Reading List

Contributors Stargazers Issues MIT License


Logo

Techtonic Reading List

A book list of authors that have been intervered on Mark Hurst's show, Techtonic on WFMU
Explore the docs »

Live Site · Report Bug · Request Feature

Table of Contents
  1. Project Feautres
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

Project Structure

Landing Screenshot

Client

The client is composed of three files:

  • index.js
    • Recent items with local storage
    • Dynamically load data
    • Lazy load images
    • Search Capabilities
  • index.html & index.css
    • Template elements
      • Book Container
      • Search Results
    • Header
    • Search Bar
    • Book List

Github Action - CRON

  • .github/workflows/getAuthor.yml
    • CRON job runs at the start of the show
    • Setup node & run getTechtonic/index.js
    • Commits changes to repo
    • Send email if job fails
  • getTechtonicBook/
    • index.js
      • Scrapes Techtonic playlist page on WFMU
      • Updates data.js with data from the scrape
    • data.js
      • Array of data points for Book List
    • data-backup.js
      • Data backup

(back to top)

Built With

  • Vanilla
  • NodeJs
  • Github

(back to top)

Getting Started

This is an example of how you may set up the data fetch locally. To get a local copy up and running follow these simple example steps.

Prerequisites

Make sure you have Node installed

  1. install pnpm
npm install pnpm@latest -g
  1. Clone the repo
    git clone https://github.com/Lombardoc4/TechtonicReadingList.git
  2. Change directory
    cd getTechtonicBook
  3. Install NPM packages
    pnpm i

Run Locally

  • Run fetch
    pnpm run fetch

Responses

  • Error:
    • Cannot get DOM from url
    • Missing book details
    • Missing book source
    • Could not write to file, data.js
  • Success:
    • No new shows
    • News shows: ...

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

(back to top)

Contact

Cris Lom - lom13@pm.me

Project Link: https://github.com/Lombardoc4/TechtonicReadingList

(back to top)

Acknowledgments

(back to top)

About

List of books from interviewed authors on Mark Hurst hosted on WFMU show Techtonic.

Resources

License

Stars

Watchers

Forks