Microverse README Template

📗 Table of Contents

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

📖 Metrics-Web-App

Metrics-Web-App is a mobile web application to that is used to check a list of metrics (numeric values) that will be created by making use of React and Redux and Data from the ACNH API.

🛠 Built With

Tech Stack

Client

• React.js
• Redux
• JavaScript
• CSS
• HTML

Key Features

Description of 1-3 key features of the application.

• When the page loads, the webapp shows the list of art pieces that could be filtered out by some parameter
• These art pieces are gotten from an API and when the user clicks (or taps) on a piece, the application navigates to the details page.
• On the details page, the webapp retrieves data from the API to show detailed data of the piece that was clicked on and when the user clicks on the "Back" button (<), the user navigates back to the home page

(back to top)

🚀 Live Demo

• Vintage Collections Web APP

Loom Presentation Video Link

• Project Documentation

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

• A Desktop or Laptop Computer running on with Windows, Mac OS or Linux operating system.
• Git installed on the Computer
• Nodejs installed on the Computer
• A browser installed on the Computer

Setup

Clone this repository to your desired folder:

• git clone https://github.com/NahnahAJ/Metrics-Web-App.git if your're using https or git
• git@github.com:NahnahAJ/Metrics-Web-App.git if you prefer ssh and hit enter.
• create a directory in your preferred location (e.g in the Desktop or Document directory)

Install

Install this project with:

• Dependencies (a packet manager is required): then you run the command npm install in the terminal

Usage

To run the project, execute the following command:

• npm run start
• This will run the project on localhost:3000

Run tests

To run tests, run the following command:

• npm run test
• This will run all tests on your local machine

(back to top)

👥 Author

I was the sole collaborator in this project.

👤 Nahnah Ahjuwah

• GitHub: @NahnahAJ
• Twitter: @NahnahAhjuwah
• LinkedIn: Felicia-Awuah

(back to top)

🔭 Future Features

Description of the new features for the project.

• I will design a logo that will be put in the nav bar and remove the current block of text that I have as my logo
• I intend to add additional pages in the website ie. a Reference page & a Categories page
• Lastly, I implement some UX improvements: include transitions and/or animations I might add more features as I move forward

(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 then kindly give me a star ⭐️ in the project repository.

(back to top)

🙏 Acknowledgments & Attribution

I would like to thank Microverse and Nelson Sakwa on Behance Owner of the original design idea. Attribution: Creatve Commons Lincense of the Design and Lastly the ACHN API.

(back to top)

📝 License

This project is MIT licensed.

(back to top)