Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/mwismann/gamedex-app

SPA built with React, Redux Toolkit, and Tailwind. The app makes use of the OpenCritic API as the backend, allowing users to dive through four different categories to get information regarding the most inquired games in the industry at the moment. Metrics are displayed in real time as the user navigates through the site.
https://github.com/mwismann/gamedex-app

jest react redux redux-toolkit

Last synced: 14 days ago
JSON representation

Host: GitHub
URL: https://github.com/mwismann/gamedex-app
Owner: mwismann
License: mit
Created: 2023-04-17T18:38:37.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2023-05-22T15:53:12.000Z (over 1 year ago)
Last Synced: 2024-12-12T18:11:39.649Z (19 days ago)
Topics: jest, react, redux, redux-toolkit
Language: JavaScript
Homepage: https://gamedex.onrender.com/
Size: 301 KB
Stars: 9
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        

# 📗 Table of Contents

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

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

    - [Tech Stack](#tech-stack)

    - [Key Features](#key-features)

- [🚀 Walkthrough](#walkthrough)

- [🚀 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)

- [👥 Authors](#authors)

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

- [🤝 Contributing](#contributing)

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

- [🙏 Acknowledgements](#acknowledgements)

- [📝 License](#license)

# 📖 [gamedex] 

**[gamedex]** is a SPA built with [React](https://react.dev/), [Redux Toolkit](https://redux-toolkit.js.org/), and [Tailwind](https://tailwindcss.com/). The app makes use of the [OpenCritic API](https://rapidapi.com/opencritic-opencritic-default/api/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](https://www.behance.net/sakwadesignstudio).

## 🛠 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](https://www.loom.com/share/cd429656b3a54e30922b5fd467b7214f)

(back to top)


### Live Demo 

[Gamedex Live Demo](https://gamedex.onrender.com/)

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

```sh

  cd my-folder

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

```

### Install

To install this project dependencies run the following command:

```sh

  npm install

```

### Usage

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

```sh

  npm start

```

### Run tests

- To test this project run the following command:

```sh

  npm test

```

### Deployment

- This is not a deployable project

(back to top)


## 👥 Authors 

👤 **Mathias Wismann**

- GitHub: [@mwismann](https://github.com/mwismann)

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

- LinkedIn: [Mathias Wismann](https://www.linkedin.com/in/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](../../issues/).

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

(back to top)