Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nahnahaj/metrics-web-app

Building a mobile web application to check a list of metrics (numeric values) that will be created by making use of React and Redux.
https://github.com/nahnahaj/metrics-web-app

metrics react reactjs redux webapp

Last synced: 8 days ago
JSON representation

Building a mobile web application to check a list of metrics (numeric values) that will be created by making use of React and Redux.

Host: GitHub
URL: https://github.com/nahnahaj/metrics-web-app
Owner: NahnahAJ
License: mit
Created: 2022-11-21T03:28:46.000Z (about 2 years ago)
Default Branch: develop
Last Pushed: 2022-11-25T10:38:05.000Z (about 2 years ago)
Last Synced: 2024-12-06T08:56:55.625Z (about 1 month ago)
Topics: metrics, react, reactjs, redux, webapp
Language: JavaScript
Homepage: https://vintage-art-collection.netlify.app/
Size: 791 KB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        



  

  


  
Microverse README Template




# 📗 Table of Contents

- [📖 About the Project](#about-project)

  - [🛠 Built With](#built-with)

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

  - [🚀 Live Demo](#live-demo)

- [💻 Getting Started](#getting-started)

  - [Setup](#setup)

  - [Prerequisites](#prerequisites)

  - [Install](#install)

  - [Usage](#usage)

  - [Run tests](#run-tests)

  - [Deployment](#triangular_flag_on_post-deployment)

- [👥 Author](#author)

- [🔭 Future Features](#future-features)

- [🤝 Contributing](#contributing)

- [⭐️ Show your support](#support)

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#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](https://vintage-art-collection.netlify.app/)

## Loom Presentation Video Link

- [Project Documentation](https://www.loom.com/share/8d32484262494a13b3ddcfea516ebf6e)

(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 

- `[email protected]: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](https://github.com/NahnahAJ)

- Twitter: [@NahnahAhjuwah](https://https://twitter.com/NahnahAhjuwah)

- LinkedIn: [Felicia-Awuah](https://www.linkedin.com/in/felicia-awuah-gyedua/)

(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](../../issues/).

(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](https://www.behance.net/sakwadesignstudio) Owner of the original design idea. Attribution: [Creatve Commons Lincense of the Design](https://creativecommons.org/licenses/by-nc/4.0/) and Lastly the [ACHN API](http://acnhapi.com/doc#tag/Art).

(back to top)


## 📝 License 

This project is [MIT](./LICENSE) licensed.

(back to top)