📗 Table of Contents

• 📗 Table of Contents
• 📖 Metrics
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
  • 💻 Getting Started
    • Prerequisites
    • Setup
    • Install
    • Usage
    • Run tests
    • Deployment
  • 👥 Authors
  • 🔭 Future Features
  • 🤝 Contributing
  • ⭐️ Show your support
  • 🙏 Acknowledgments
  • ❓ FAQ
  • 📝 License

📖 Metrics

Metrics a dynamic SPA website, using ES6 syntax, modules, React, Redux, React-Router, Async Thunks, and a Currencies Rates API.

🛠 Built With

Tech Stack

Client

• html
• css
• JavaScript/ES6
• React
• Redux

Server

• N/A

Database

• N/A

Key Features

• React metrics app
• Jest components testing
• Async thunks to fetch data from API

(back to top)

🚀 Live Demo

• https://metrics-4byw.onrender.com/
• Video walkthrough

(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:

• Git SCM
• Visual Studio Code
• Live Server extension

Setup

Clone this repository to your desired folder:

git clone https://github.com/jorgeabrahan/metrics.git

Or download the ZIP folder.

Install

Once you've cloned the repository simply run:

cd metrics
npm i

And if you want to analyze the code you can run:

code .

To open the project in VScode

Usage

To run the project, if you are on the metrics folder path on your terminal you can execute the following command:

npm start

Run tests

To run tests:

npm test

Deployment

npm run build

(back to top)

👥 Authors

👤 Jorge Abrahan

• GitHub: @jorgeabrahan
• LinkedIn: Jorge Abrahan

(back to top)

🔭 Future Features

• Display more data from the API

(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 you can just cheer me up with a comment 🙂!

(back to top)

🙏 Acknowledgments

Currencies API used for this project: https://github.com/fawazahmed0/currency-api#readme

Design guidelines for this project : https://www.behance.net/gallery/31579789/Ballhead-App-(Free-PSDs) by Nelson Sakwa on Behance

(back to top)

❓ FAQ

• What is this project main purpose?

  • To practice working with React, Redux, Routers, Async Thunks and APIs.

(back to top)

📝 License

This project is MIT licensed.

(back to top)