/currency-exchanger

For this week's project, you'll create a currency exchange application. A user should be able to type in an amount (in U.S. dollars) and then choose which currency it should be converted to (such as francs, marks, rupees, and so on). To determine the most recent exchange rate, your application will make an API call to the following exchange rate API.

Primary LanguageJavaScript

Currency Exchanger

This is the Curency Exchanger Project created by John Edmondson

Week 6 Project for the March 2021 Co-hort session: Asynchrony and APIs

By John Edmondson

Technologies Used

  • HTML
  • CSS
  • Bootstrap CSS Framework
  • Google Fonts
  • Git
  • VS Code
  • Javascript
  • Jquery
  • Webpack
  • Babel
  • ESlint
  • Jest
  • ENV Loader
  • ExchangeRate-API

Description

This project was created to convert currencies from one to another while using the ExchangeRate-API to find the exchange rate.

Setup and Use

Prerequisites

Installation

  1. Clone the repository: $ git clone https://github.com/basicjohn/currency-exchanger.git
  2. Navigate to the currency-exchanger/ directory on your computer
  3. Open with your preferred text editor to view the code base
  4. To start a development server and view the project in the browser:
    • Navigate to currency-exchanger/ in your command line
    • Run the command npm install to install dependencies
    • Optionally, run the commmand npm run build to make a bundle of the files
    • Finally, run the command npm run start to start a development server
  5. To run tests, navigate to currency-exchanger/ in your terminal and run the command npm run test

API key setup

  1. Visit the ExchangeRate-API site. Input your email address and click the "Get Free Key" button.
  2. You'll be prompted to create an account with your email, first name and a password. Agree to the terms of use and click "Get Started!"
  3. Copy the API Key from the API Access section of the Dashboard.
  4. Create a new file named .env & save it to the root of the project folder.
  5. In the .env file type "API_KEY=" (only the text inside the quotations)
  6. After the equals sign paste the API key.
  7. Save the file

Known Bugs

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE."

Contact Information

John Edmondson edmondsonj@gmail.com