Giter Club home page Giter Club logo

clockandgreeting's Introduction

Hello In Time Tech!

I had a lot of fun putting this application together and I am excited to demo it for you!

The Goal of the INSPIRE app

Per your intructions, below is the goal for this application and what the final product should look like.

Part 1 – Responsibilities

It is your responsibility to render each piece of the data from the services out to the screen with real time accuracy (Clock will tick if the minute turns).

Part 2 – Requirements

Visualization

  1. The data from the services are each rendered. Quote, Image, Weather, and Clock
  2. The image should fill the screen with the widgets overlaying the photo

Functionality

  1. The clock should display your current time and progress forward if a minute passes (no need to account for time zones)
  2. The quote will refresh with page load
  3. The weather will be accurate for your location
  4. No need to base it off GPS/computer location

Part 3 - Prettify

The positioning of elements on the page is not the absolute most crucial thing for this application however we do want to see some thought put into the layout. Copy the image above if you’d like.

Stretch Goals

  • On hover the quote should show the author of the quote and disappear when not hovered over
  • Change the message from Good Morning to Good Afternoon, Evening as appropriate.
    • Morning = 6am-12pm
    • Afternoon = 12-5pm
    • Evening = 5-10pm
    • Night = 10pm-6am
  • Allow the user to toggle the clock from, 12hr to military time.
  • Include an Icon to show what the weather is sunny/cloudy/rainy
  • Add a button to cycle to next quote/picture

Breaking it Down

After breaking down the example image I have a pretty clear idea of how to proceed and built a flowchart to map out my route.

The Project has been completed to the requirements and you can download it to run on your local machine.

Get the App

You can run the app on your local machine by following the instructions below.

Step One: Git the Repo

  1. Clone this repository to your local machine and open it in your code editor.

Step Two: Download the Packages and add API key

  1. Run the following command in the root directory's terminal to download the needed packages
    npm install
    
  2. The Open Weather API requires an API key to access their endpoints. First, follow the documentation HERE to sign up and get your own free API key
  3. Once you have your API key you must create a config folder in the root directory to hold that key.
  4. Within your config folder create a file named 'weatherAPIkey.js' and within it add the following code:
    const WEATHER_API_KEY = 'YOUR_API_KEY_FROM_OPEN_WEATHER';
    export default WEATHER_API_KEY;
    
    Make sure the the API key is within quotes to make it a string.
  5. Add the config folder to your .gitignore file so your API key remains private

Step Three: Spin Her Up

  1. Once you have completed the inital setup, it is ready to run! Make sure you do not have anything running on you localhost port 8080.
  2. Run the following commands to spin it up:
    npm run react-dev
    npm run start
    
  3. Finally, type the url 'localhost:8080' into your browser and you will see the application running!

My Final Product came out pretty well, if I do say so myself. Let me take you through a tour of the features...

Thats pretty much it, thanks for taking the time to walk through this with me and have a fantastic day!

clockandgreeting's People

Contributors

krissingl avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.