zahnen / armageddon2.0

Armageddon 2.0

A webpage created to test calling APIs, November 18, 2020

By Zahnen Garner & Cory Nordenbrock

Description

This webpage was created for coursework at Epicodus. The webpage allows users to view information for a imagined doomsday bunker sales site and was created as a simple practice with calling APIs.

Setup/Installation Requirements

If you would like to run the webpage locally

• Open your git-capable command line program (I recommend Terminal on Mac or Git Bash on PC)
• Ensure you are within the directory you'd like the file to be created in.
• Enter the command "$ git clone https://github.com/Zahnen/armageddon2.0" in your command line
• Once cloned, use the "$ cd " command to navigate to the directory created in the previous step.
• You must have node.js installed in order to run the webpage successfully. If you do not have node.js installed, find more information and download it here
• Once in the newly cloned directory, run "$ npm install" in your command line to install the necessary packages and dependencies.
• This program uses an API provided by NASA and has been tested using a hidden key. In order to test on your local device, you'll need to generate your own API key here
• Once you have your API key, replace the "${process.env.API_KEY}" within the url on Line 3 of exchange-service.js with your new key.
• Alternatively, if you'd like to keep your key encrypted for publishing, skip the previous step and instead create a file called ".env" at the root level of your project directory. Input the code "API_KEY=" (minus the quotation marks) into this file and follow that line with your unique API key. As this project supports environmental variables, your API key will now be held in the "${process.env.API_KEY}" variable
• To open the webpage in your default browser, run "$ npm start".

Known Bugs

There are no known bugs at this time.

Support and contact details

If you notice a bug or require support, please reach out to me via email. I can be reached at [email protected]

Technologies Used

This webpage required use of the following programs/languages/libraries to create:

• GitBash
• Visual Studio Code
• GitHub
• GitHub Pages
• HTML
• CSS
• Bootstrap
• JavaScript
• JQuery
• npm
• Nasa API

License

Licensed under MIT

API kindly provided by NASA

Copyright (c) 2020 Zahnen Garner & Cory Nordenbrock