Skip to content

Xapixowy/arkham-horror-frontend

Repository files navigation

logo

Arkham Horror

Application to make Arkham Horror games easier.

This repository is closely linked to another one, which handles the backend, while this one is the frontend.

Table of contents

Description

The application was designed to simplify managing characters and game elements during Arkham Horror board game sessions. It provides real-time updates on the game phase and allows easy management of items, spells, companions, and other resources directly through the interface.

Tech Stack

logo

Angular is a popular open-source web application framework developed by Google for building dynamic, single-page applications using HTML, CSS, and TypeScript.

logo

PrimeNG is a collection of rich UI components for Angular, offering a wide range of customizable and responsive elements to build modern web applications.

logo

NgRx is a state management library for Angular applications, inspired by Redux, that helps manage application state using reactive programming and RxJS for better scalability and maintainability.

logo

Socket.IO client is a JavaScript library for real-time, bidirectional communication between web clients and servers, allowing the frontend to easily connect to a Socket.IO server for features like chat, live updates, and real-time notifications.

logo

Docker is an open-source platform that automates the deployment and management of applications using containers, allowing for consistent environments across different systems.

Installation

To simplify the installation process, the project uses a Docker.

Remember, this application is tightly linked to the backend, and you should also set up that project to get the full functionality.

Prerequisites

Steps

1. Environment variables

Copy .env.example file to .env. You don't need to make any changes there.

cp .env.example .env

2. Build Docker container

Just run the command to build the container and wait.

docker-compose up -d

3. Enjoy :)

About

Arkham Horror Companion App: An Angular-based web app for the board game

Topics

Resources

Stars

Watchers

Forks

Contributors