📗 Table of Contents

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

📖 [gamedex]

[gamedex] is a SPA built with React, Redux Toolkit, and Tailwind. The app makes use of the OpenCritic API as the backend. The app allows users to dive through four different categories to get information regarding the most inquired games of the industry at the moment. Metrics are displayed in real time as the user navigates through the site. Original design idea by Nelson Sakwa on Behance.

🛠 Built With

Tech Stack

Client

• HTML
• CSS
• JavaScript
• React
• Redux Toolkit
• Tailwind

Server

• Render

Database

• OpenCritic API

Key Features

• [Integration of Jest and React Testing Library for tests]
• [Correct Redux integration]
• [Correct async consumption of API]
• [Correct integration of Tailwindcss styling]

(back to top)

Walkthrough

Walkthrough

(back to top)

Live Demo

Gamedex Live Demo

(back to top)

💻 Getting Started

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

Prerequisites

• You don't need any previous installation in order to run this project

Setup

Clone this repository to your desired folder:

  cd my-folder
  git clone https://github.com/mwismann/gamedex-app.git

Install

To install this project dependencies run the following command:

  npm install

Usage

• To start this project on your localhost run the following command:

  npm start

Run tests

• To test this project run the following command:

  npm test

Deployment

• This is not a deployable project

(back to top)

👥 Authors

👤 Mathias Wismann

• GitHub: @mwismann
• Twitter: @mathias_wismann
• LinkedIn: Mathias Wismann

(back to top)

🔭 Future Features

• [Improve Desktop version]
• [Improve UX with animations and transitions]
• [Implement additional pages]

(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 it would be a great help if you could star this repo!

(back to top)

🙏 Acknowledgments

I would like to thank to Microverse for providing me the opportunity and inspiration for this work.

(back to top)

📝 License

This project is MIT licensed.

(back to top)