https://github.com/dnyaneshwargiri/bingo-app

A Bingo app developed in React
https://github.com/dnyaneshwargiri/bingo-app

ant ant-design bingo bingo-game bingo-generator react typescript zustand

Last synced: about 1 month ago
JSON representation

A Bingo app developed in React

• Host: GitHub
• URL: https://github.com/dnyaneshwargiri/bingo-app
• Owner: dnyaneshwargiri
• Created: 2024-11-10T18:21:37.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-12T14:52:31.000Z (about 1 month ago)
• Last Synced: 2024-11-12T15:33:16.453Z (about 1 month ago)
• Topics: ant, ant-design, bingo, bingo-game, bingo-generator, react, typescript, zustand
• Language: TypeScript
• Homepage: https://dnyaneshwargiri-bingo-app.netlify.app/
• Size: 46.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  Table of Contents

  


    


      About The Project

      


        
Built With

      

    

    


      Getting Started

      


        
Prerequisites

        
Installation

      

    

    
Live Demo

  


## About The Project

A simple and interactive Bingo game built with React, TypeScript, and Zustand for state management, offering an engaging experience with a customizable bingo card. The app allows users to play Bingo with predefined phrases, dynamically generate bingo cards.

### Built With

Below are frameworks/ libraries used to bootstrap this project.

- ![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB)

- ![Zustand](https://img.shields.io/badge/zustand-%23404d59.svg?style=for-the-badge&logo=zustand&logoColor=%2361DAFB)

- ![Ant-Design](https://img.shields.io/badge/-AntDesign-%230170FE?style=for-the-badge&logo=ant-design&logoColor=white)

- ![Pnpm](https://img.shields.io/badge/pnpm-%232C8EBB.svg?style=for-the-badge&logo=pnpm&logoColor=white)

- ![Vite](https://img.shields.io/badge/vite-%23646CFF.svg?style=for-the-badge&logo=vite&logoColor=white)

- ![Jest](https://img.shields.io/badge/jest-%23C63D14.svg?style=for-the-badge&logo=jest&logoColor=%23FFFFFF)

## Getting Started

Below are instructions on setting up your project locally.

### Prerequisites

- Node 21

- Yarn 8.15.4

- Typescript": ^5.6.2

### Installation

1. Clone the repo

   ```sh

    git clone https://github.com/dnyaneshwargiri/bingo-app.git

   ```

2. Install NPM packages

   ```sh

    pnpm install/ yarn install

   ```

3. Compile bingo app

   ```sh

   pnpm build

   ```

4. Run

   ```sh

   pnpm start /* production */

   pnpm dev /* dev mode */

   ```

## Test and Lint

Run test cases

```sh

pnpm test

```



Check for linting Warnings, Error

```sh

pnpm lint

```

## To run application via Docker Image

1. Build application for production

   ```sh

     pnpm build

   ```

2. Build Docker image

   ```sh

     chmod +x ./docker.build.sh

   ```

   ```sh

    ./docker.build.sh

   ```

3. Run Docker image

   ```sh

     docker run -p 4000:4000 bingo-app

   ```

Please be informed commits are intentionly not squashed.

## Open issue

  Click on matrix cell at lower device on focus state can be enhanced.