Skip to content

Pinball Wizard is a mobile web app that uses the data from the Pinball Map Api to display the total count of pinball machines in USA and breaks down the top 10 cities by location and number of machines.

License

Notifications You must be signed in to change notification settings

jfoyarzo/pinball-wizard

Repository files navigation

📗 Table of Contents

📖 Pinball Wizard 🧙‍♂️

Pinball Wizard is a mobile web app that uses the data from the Pinball Map Api to display the total count of pinball machines in USA and breaks down the top 10 cities by location and number of machines.

🛠 Built With

Tech Stack

Client
State Management
API

Key Features

  • All the machines: Displays the total count of pinball machines in USA
  • Top cities: Displays a list of the 10 cities with most number of machines
  • Location breakdown: Displays a list of location for a given city and the number of machines present

(back to top)

🚀 Live Demo

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

  • Node.js
  • Npm
  • Git

Setup

Clone this repository to your desired folder:

  • git clone git@github.com:jfoyarzo/pinball-wizard.git

Install

Install this project's dependencies with:

  • npm install

Usage

To run the project, execute the following command:

Run npm start on the app folder to serve files for access on http://localhost:3000/

Run tests

To run tests, run the following command:

  • npm test

Deployment

You can deploy this project using:

  • npm run build

(back to top)

👥 Authors

👤 Felipe Oyarzo

(back to top)

🔭 Future Features

  • Tablet and Desktop Version
  • Location details view with information about each location
  • Spinner while fetching the data

(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 please give it a ⭐!

(back to top)

🙏 Acknowledgments

Original UI design by Nelson Sakwa on Behance.

(back to top)

📝 License

This project is MIT licensed.

(back to top)

About

Pinball Wizard is a mobile web app that uses the data from the Pinball Map Api to display the total count of pinball machines in USA and breaks down the top 10 cities by location and number of machines.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published