https://github.com/mejia-dev/currency-exchanger
https://github.com/mejia-dev/currency-exchanger
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/mejia-dev/currency-exchanger
- Owner: mejia-dev
- Created: 2023-11-17T16:53:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-18T01:29:53.000Z (over 2 years ago)
- Last Synced: 2025-01-10T05:38:29.631Z (over 1 year ago)
- Language: JavaScript
- Size: 1.79 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Currency Exchanger
#### This project uses an API to get current exchange rates for multiple currencies.
#### By github.com/mejia-dev
## Technologies Used
* HTML
* CSS
* JavaScript
* webpack
* npm
* Jest
* ESLint
* Babel
* Dotenv
* Exchangerate-API (https://www.exchangerate-api.com/)
## Description
This project utilizes the Exchangerate-API from exchangerate-api.com to get currency conversions.
Features:
* Allows users to convert currency between all available currency types.
* Allows users to convert currency both to and from U.S. dollars.
The project must be self-assembled following the steps below.
## Setup/Installation Requirements
Obtain API Key:
* Navigate to https://app.exchangerate-api.com/sign-up in your browser of choice.
* Sign up for an account.
* On the first page that appears after account creation, you will receive an API key.
Project Setup
* Clone this repository to your desktop (from the Git Bash console, run "git clone https://github.com/mejia-dev/currency-exchanger.git" without quotes).
* From the Git Bash console, run "npm install" without quotes.
* Create a new file called ".env" without quotes in the root directory of the project.
* Open the .env file and enter "API_KEY=" without quotes, followed by the API key obtained from the website in the step above.
* Build Distribution: From the Git Bash console, run "npm run build" without quotes.
* Launch Webserver: From the Git Bash console, run "npm run start" without quotes.
## Known Bugs
* none
## License
MIT License
Copyright (c) 2023 github.com/mejia-dev
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.