https://github.com/tinsaye-simeneh/et-cash

https://github.com/tinsaye-simeneh/et-cash

Last synced: 11 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/tinsaye-simeneh/et-cash
• Owner: tinsaye-simeneh
• Created: 2023-12-01T16:42:02.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-11-07T05:43:54.000Z (11 days ago)
• Last Synced: 2024-11-07T06:28:59.944Z (11 days ago)
• Language: JavaScript
• Homepage:
• Size: 514 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Virtual Game Cashier

**Virtual Game Cashier** is a retail cashier interface designed for virtual games like **Spin** and **Keno**. This project aims to provide a seamless user experience for cashiers handling virtual game transactions. Built with **React.js** for a fast and responsive UI and styled with **Tailwind CSS** for efficient and flexible design. The application also uses **Axios** for smooth, reliable API communication. Also used many other packages for some services, check it out here: [Tech Stack](#tech-stack)

## Table of Contents

- [Features](#features)

- [Tech Stack](#tech-stack)

- [Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Installation](#installation)

  - [Running the Project](#running-the-project)

- [Usage](#usage)

- [API Integration](#api-integration)

- [Contributing](#contributing)

## Features

- **User-Friendly Interface**: Simple and intuitive design for easy navigation and quick transactions.

- **Game-Specific Cashier Options**: Supports virtual game types like Spin and Keno, with customized settings for each.

- **Real-Time API Communication**: Axios-powered API requests to handle game and transaction data efficiently.

- **Responsive Design**: Fully responsive UI for different screen sizes, thanks to Tailwind CSS.

- **Transaction Management**: Allows cashiers to view, manage, and process game transactions smoothly.

## Tech Stack

- **Frontend**: React.js

- **Styling**: Tailwind CSS

- **API Calls**: Axios

- **React Toastify**: for notification

- **react-barcode**: for barcode generation

- **react-icons**: for icon components

- **react-redux**: for state management

- **react-to-print**: printing service

- **clsx**: excel file export

- **react-router-dom**: for routing

## Getting Started

To set up the Virtual Game Cashier on your local machine, follow these steps:

### Prerequisites

- Node.js (v14 or above)

- npm or yarn

### Installation

1. Clone the repository.

2. Install the dependencies.

### Running the Project

Start the development server. The application will run at `http://localhost:3000`.

## Usage

1. **Home Page**: Displays a dashboard for the cashier to choose games and manage transactions.

2. **Game Selection**: Choose a virtual game (Spin, Keno) and view game-specific options.

3. **Transaction Handling**: Process transactions quickly, view recent transactions, and manage receipts.

## API Integration

The application uses Axios for handling API requests to connect to the backend services. The API endpoint can be set up in a dedicated configuration file.

## Contributing

We welcome contributions! Please fork the repository and create a pull request for any improvements, bug fixes, or new features.