Skip to content

Latest commit

 

History

History
51 lines (30 loc) · 2.26 KB

README.md

File metadata and controls

51 lines (30 loc) · 2.26 KB

Cat Service

This project is setup for experimentation with the Express library and API communications. The service uses The Cat API, Cat as a Service and runs via a Node/Express frontend for backend solution.

Due to the use of Express this service has been deployed via Heroku as a free hosting solution. The service is auto deployed everytime the master branch is updated.

The service currently allows the user to click an image and view a new Cat image loaded from an API. The frontend is displayed on a basic React frontend. An additional Spotify player has been included with random cat ASMR tracks. (generated using the react-spotify-player library)

Note: as this is deployed on a free-tier of Heroku there is some initial delay on the first initial click.

Mobile

Mobile Screenshot

Desktop

Desktop Screenshot

Running Locally

You will need to build the app locally and run straight from the build. A proxy is setup in the package.json that should allow for the service to auto forward to port 8080:

npm run build
npm run start
  • An additional debugging option is available at npm run dev to help aid in local style formatting. Note that calls to the server will not function correctly in this mode.
  • To keep updated with security patches run npm audit fix

Further Applications Ideas

  • Integration of music/playlist

  • Improved UI layout & design

    • Integration of Grid-Styled library ✔ Completed
    • Integration of React-Bootstrap Navbar [needs more features first]
    • Footer: Credits to APIs & Services Used included in Footer ✔ Completed
  • Additional Components

    • Multiple random images displayed at once
    • Carousel options
  • Hosting

    • Host publically -> due to use of server an alternate free service to Github Pages required (Heroku perhaps...) ✔ Completed