kpundt93 / currency-exchanger

Epicodus week 6 independent project

Currency Exchanger

By: Katie Pundt

An application to convert USD to a chosen currency.

Technologies Used

• HTML
• CSS
• Bootstrap
• JavaScript
• jQuery
• npm
• webpack
• eslint
• popperjs/core
• APIs
• git
• GitHub

Description

The application will allow users to input an amount in USD and then enter the currency code of the currency that they would like to convert to and then get the converted amount.

Setup/Installation Requirements

• Navigate to https://github.com/kpundt93/currency-exchanger
• Click on the green "Code" button and copy the repository URL or click on the copy button
• Open the terminal on your desktop
• Once in the terminal, use it to navigate to your desktop folder
• Once inside your desktop folder, use the command git clone https://github.com/kpundt93/currency-exchanger.git
• After cloning the project, navigate into it using the command cd currency-exchanger
• Use the command git remote to confirm the creation of the new local repository
• Open the project in your preferred text editor
• Create a new file in the root of the project directory called .env
• Open your web browser and follow this link: https://www.exchangerate-api.com/
• Enter your email address and then check your email for an activation link
• Upon clicking the activation link in your email you'll be taken to a page with your API key
• Copy this key and return to the empty .env file that you created
• In the .env file type the following API_KEY=[YOUR_API_KEY_HERE] and paste your API key in place of [YOUR_API_KEY_HERE] (be sure to remove the square brackets)
• Save the project
• Navigate back to your terminal
• Install project dependencies by running the command npm install
• If you receive errors in the terminal, try running npm install again, sometimes npm can be finicky
• Then run the command npm run start to start the project server and view the application (use ctrl + c to exit the server in the terminal)

Troubleshooting

• If you are receiving errors regrading webpack, try running the command npm install webpack@4.39.3 --save-dev --save-exact, then run npm run build again
• If you continue to have issues setting up the environment, try deleting the package-lock.json file and the node_modules folder from the project. Then rebuild the environment by running npm install again.

Known Bugs

• No known bugs

Contact Information

Katie Pundt, [e-mail]

License

MIT License: https://opensource.org/licenses/MIT

Copyright (c) 2021 Katie Pundt