Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/koladev32/currency-exchange-widget


https://github.com/koladev32/currency-exchange-widget

Last synced: 3 days ago
JSON representation

Awesome Lists containing this project

README

        

# FX Currency exchange

Quick demo [here](https://upbeat-elion-6bb72d.netlify.app/).

## Quick start guide

2 scripts are provided:

- `yarn start` - starts the application on `https://localhost/3000`
- `yarn test` - runs the test cases defined in `__tests__` folder on `src/components` and `src/store`

## Disclaimer

This application uses the ```https://api.exchangerate.host/``` FX rates source api because the Free plan to ```https://openexchangerates.org/api/``` only allows conversion for USD to all currencies.
This has been very helpful to build the multi-currency exchange widget.

## Features

- [X] Refresh the rate every 10s (we do not expect the rate to change every 10s as most free
rate sources won't provide live rates).
- [X] Contain three currency accounts with USD, EUR, GBP.
- [X] Make it possible to make an exchange between accounts.
- [X] Contain two inputs on the exchange screen for both accounts. Each input should be
validated to let the user type only numbers with two digits after the dot.
- [X] Give all the necessary information: exchange rate between active accounts and account
balances

## Amelioration and critics

- Feature to swap fields for selling or buying
- Remove the base currency from the second list of currencies
- Add multiple currencies and account
- More tests coverage using Enzyme to include state testing

## Autogenerated docs ....

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## Available Scripts

In the project directory, you can run:

### `yarn start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `yarn test`

Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `yarn build`

Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!

See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.

### `yarn eject`

**Note: this is a one-way operation. Once you `eject`, you can’t go back!**

If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).

To learn React, check out the [React documentation](https://reactjs.org/).