Skip to content

Commit

Permalink
chore: Remove links and remove vercel deployment
Browse files Browse the repository at this point in the history
  • Loading branch information
bartoszputek committed Oct 22, 2024
1 parent 10992c0 commit 408d78a
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 43 deletions.
46 changes: 27 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,39 @@
# Poker Master Tool
Open-source poker hand calculator available on https://pokermastertool.bartoszputek.com/

Open-source poker hand calculator.

## Table of contents
* [General info](#general-info)
* [Architecture](#architecture)
* [Features](#features)
* [Quick start with Docker](#quick-start-with-docker)
* [Installation](#installation)
* [Unit and performance tests](#unit-and-performance-tests)
* [Development](#development)
* [License](#license)

- [General info](#general-info)
- [Architecture](#architecture)
- [Features](#features)
- [Quick start with Docker](#quick-start-with-docker)
- [Installation](#installation)
- [Unit and performance tests](#unit-and-performance-tests)
- [Development](#development)
- [License](#license)

## General info

This project has been written to a develop fast open-source hand calculator for Texas Hold'em as an Engineering Thesis. It uses TwoPlusTwo evaluator for calculating hand ranks. The repository contains unit and performance tests, Docker image with Docker Compose for quick start and configured CI/CD with GitHub Actions.

![Application view](./readme/application-view.png)

## Architecture

The Application is split into 3 projects:
* Node.js backend application built with Typescript and Express.js framework
* Frotend written in pure JavaScript and Webpack bundler located in `frontend` directory
* C++ Addon with TwoPlusTwo table generator in `addon` directory

- Node.js backend application built with Typescript and Express.js framework
- Frotend written in pure JavaScript and Webpack bundler located in `frontend` directory
- C++ Addon with TwoPlusTwo table generator in `addon` directory

## Features
* Responsive web application for Poker Texas Hold'em odds calculator up to 9 players
* Displaying the number of enumerated combinations and hand rank probability for each player
* Support for Death Cards
* Request caching on the backend side
* Logging requests with log retention politics stored inside `logs` directory

- Responsive web application for Poker Texas Hold'em odds calculator up to 9 players
- Displaying the number of enumerated combinations and hand rank probability for each player
- Support for Death Cards
- Request caching on the backend side
- Logging requests with log retention politics stored inside `logs` directory

## Quick start with Docker

Expand All @@ -45,7 +52,7 @@ To install the application you should have installed Node 16 version, make and g
Next, follow consecutive commands:

```bash
npm install
npm install

npm run build:all

Expand Down Expand Up @@ -89,6 +96,7 @@ npm run dev:frontend
```

## License

You can check out the full license [here](./LICENSE)

This project is licensed under the terms of **the MIT license**.
This project is licensed under the terms of **the MIT license**.
24 changes: 0 additions & 24 deletions vercel.json

This file was deleted.

0 comments on commit 408d78a

Please sign in to comment.