SAbramson16 / Outdoor-Companion

0 stars 0 forks source link

My Outdoor Journey Companion

The Outdoor Journey Companion web application was desgined to assist a user's outdoor activities by providing the most relevant information all on a single page. This includes the current and subsequent weather conditions, mood-based music playlist, and a quote of the day to provide inspiration.

At start, the user will choose and submit their location and music preference. Following this, the application will transition them to the display screen where all relevant items will be displayed.

Features

API Reference

Server-Side APIs

Quotable API

  (https://docs.quotable.io/docs/api/ZG9jOjQ2NDA2-introduction)
Endpoint Parameter Description
random maxLength random quote of max 120 words

OpenWeatherMap API

  (https://openweathermap.org/api)
Endpoint Parameter Description
direct cityName, limit, appid get city long and lat coordinates
weather units, long-lat, appid current weather conditions of a city
forcast units, long-lat, appid upcoming conditions, 3-hour intervals

SoundCloud API

  (https://developers.soundcloud.com/docs/api/html5-widget)
Endpoint Parameter Description
playlist playlist-number, widget displays a chosen playlist widget on the page

Third-Party APIs

Bulma CSS Styling API (https://bulma.io/)

Free, open-source framework providing ready-to-use and responsive frontend components.

Google Fonts https://fonts.google.com/)

Stylized, open-source computer font and web font service owned by Google.

Day.js (https://day.js.org/)

JavaScript Library: Parses, validates, manipulates, and displays dates and times.

jQuery (https://api.jquery.com/)

JavaScript Library: makes DOM traversal, manipulation, event handling, and animation much simpler, works across multiple browsers.

Roadmap

Authors

Deployment

Website URL

  (https://sabramson16.github.io/Proj1.Outdoor-Companion/)

GitHub Repository

  https://github.com/SAbramson16/Proj1.Outdoor-Companion

GitHub Project

  https://github.com/users/SAbramson16/projects/1

Demo

User Start Screen - demo

Getting Started

User Display Screen - demo

Getting Started