Skip to content

Latest commit

 

History

History
112 lines (65 loc) · 2.1 KB

README.md

File metadata and controls

112 lines (65 loc) · 2.1 KB
Raw

Currencies Catalogue

A React Redux application that fetches an API and list the top 25 available CryptoCurrencies.

screenshot

Desktop view

screenshot

Mobile view

Additional description about the project and its features.

Built With

  • ReactJS
  • Redux
  • Redux thunk
  • Material UI

Tested With

  • Jest
  • Enzyme
  • redux-mock-store
  • moxios

Live Demo

Live Demo Link

Getting Started

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

Prerequisites

  • NodeJS
  • Code Editor

Setup

Open up a terminal (after installing Git) and run the following command:

  git clone https://github.com/martinnajjar12/currencies-catalogue

and hit Enter.

OR

Download a zip version of the project from the above button.

Install

Run in your command line:

  npm install

Usage

In order to open it in your browser, you need to dispatch the following command:

  npm start

Note: Please be noted that API may not work on your local computer because you don't have the API KEY. You need to get your key from nomics.com

Run tests

To test the application please run this command:

  npm test

Authors

👤 Martin Najjar

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

Show your support

Give a ⭐️ if you like this project!

Acknowledgments

📝 License

This project is MIT licensed.