Skip to content

cophilot/board-score-hub

Repository files navigation


board-score-hub

board-score-hub

A collection of digitital score sheets for a broad variety of board games.


BoardScoreHub is a web application that is used for keeping track of scores for board games. It is a simple and easy-to-use application that allows users to create and manage games, players, and scores. The application is built using React.


Missing a game?

Add a Game Request on the Issues page.


Development

Perquisites for development are Node.js and pnpm.

To start the development server, run the following command:

pnpm setup # install dependencies and setup husky
pnpm start # start the development server

Game Definition

The game definition defines the structure of the table for the game. You can find the interface for the definition here.


Add a game

Add a new folder in the games directory with the structure of the other games. Alternative you can install templify and run the following command and fill out the prompts:

tpy generate game <game-name>

After adding the game folder you have to register the game in the allGames.ts file.


Project Structure

  • src/core: Core logic for the table page rendering and score calculation and storage.
  • src/core/main: Contains the BoardScorePage and BoardScoreTable components that are responsible for rendering the main page and table.
  • src/core/state: Contains state management logic for the application.
  • src/core/types: TypeScript types used throughout the core logic.
  • src/games: Contains all the game definitions and related assets.
  • src/providers: Context providers for state management and other global functionalities.
  • src/views: Different pages of the application (e.g., Home, About, ...).
  • src/components: Common components used throughout the application.

by Philipp B.

About

A collection of digitital score sheets for a broad variety of board games.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages