Daron976/currency-ex

This is a currency exchange app that allows users to convert the currency of any country to the another currency while providing data about the country in question.

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Prerequisites
  • Setup
  • Install
  • Usage
  • Run tests
  • Deployment
• 👥 Authors
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• ❓ FAQ
• 📝 License

📖 Currex

This is a currency exchange app that allows users to convert the currency of any country to the another currency while providing data about the country in question.

🛠 Built With

Tech Stack

Client

• React.js
• Redux
• JS
• Visual Studio
• Webpack
• Eslint
• Stylelint
• Babel
• Jest

Key Features

• Fetches data from Api
• Render API data on an SPA
• Responsive Application

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

• Html & CSS basics
• JS basics
• Broad Understanding of React
• Broad Understanding of Redux
• Git & github

Setup

Clone this repository to your desired folder:

• Click on the green button on the top right corner with the text code
• Click on SSH
• Copy the text that appears below
• Type "git clone" in your terminal and past the copied text next to "git clone" and press enter

Install

Install this project with:

• Click on the green button on the top right corner with the text code
• Click on "Download ZIP"
• Extract the downloaded file locally
• Once oponed up in a code editor run npm install to install all packages

Usage

To run the project, execute the following command:

• Allow users to learn about rockets.

Run tests

To run tests, run the following command:

• Run npm test in an intergrated terminal to run automated tests.

Deployment

You can deploy this project using:

• Run npm start in an intergrated terminal in order to start a local live server.

(back to top)

👥 Authors

👤 Daron Wiafe

• GitHub: @githubhandle
• Twitter: @twitterhandle
• LinkedIn: LinkedIn

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project...

Feel free to give it a start

(back to top)

🙏 Acknowledgments

Give credit to everyone who inspired your codebase.

I would like to thank REST COUNTRIES and Currency API for the database.

I would also like to thank Nelson Sakwa the author of the original design for a great design.

(back to top)

❓ FAQ

• What is an SPA

  • A single-page application (SPA) is a web application or website that interacts with the user by dynamically rewriting the current web page with new data from the web server, instead of the default method of a web browser loading entire new pages.

• Is the page compatible with mobile

  • Yes, this application is only for mobile at the moment.

(back to top)

📝 License

This project is MIT licensed.

NOTE: we recommend using the MIT license - you can set it up quickly by using templates available on GitHub. You can also use any other license if you wish.

(back to top)