Skip to content

Commit

Permalink
Updating readme
Browse files Browse the repository at this point in the history
  • Loading branch information
WesCook committed Apr 25, 2024
1 parent 5dca227 commit b2a828b
Showing 1 changed file with 21 additions and 7 deletions.
28 changes: 21 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,31 @@

[Open the web app](https://wescook.ca/BacklogBingo/) to get started!

## Explanation
## Intro

Created for the **Tildes Backlog Burner** event, this app will generate a bingo card to help you complete your backlog. For example, a bingo card could have a tile labelled "a game in a genre you don't normally play". You would then play that game and fill in the respective tile. The goal is to complete a bingo pattern of your choosing.
Created for the **Tildes Backlog Burner** event, this app will generate a personalized bingo card. The categories come from either prebuilt lists or your own provided JSON. While originally designed to target backlogs, this app can be effectively used for any type of bingo card.

The app allows you to customize the game rules, select from a list of possible challenges, and will then generates a unique bingo card for you. You can update your progress by returning to the app to record any games you've played, and print a table in Markdown for easy sharing online.
To generate a card, first select or provide a list of categories. Then choose a game mode to customize how you'd like to play. Finally, you can filter out any categories that don't suit you. Once you're ready, click _Generate Card_ to create your personalized bingo card.

Once downloaded, this app runs entirely in your browser. None of your settings are stored server-side. As such, please do not clear browser data such as local storage to avoid data loss.
The card will be saved to your browser, and you can return to update it at any time. Some built-in logic is included, such as detecting duplicate entries or satisfying win conditions. A Markdown table will be automatically generated below the card for easy sharing to supported social media.

Once loaded, this app runs entirely in your browser. None of your settings are stored server-side. As such, please do not clear your browser data to avoid data loss.

## Features

- [Category lists](/WesCook/BacklogBingo/wiki/Category-List) come included, or can be imported via file or URL
- [Group system](/WesCook/BacklogBingo/wiki/Groups) to discourage similar categories from generating together
- [Dynamic categories](/WesCook/BacklogBingo/wiki/Dynamic-Categories) for more unique combinations
- [Game rules](/WesCook/BacklogBingo/wiki/Game-Rules) can be customized individually, or chosen as game modes
- Light and dark mode support
- Accessibility for mobile and keyboard navigation
- Duplicate entry and win detection logic
- Markdown table generation for easy sharing
- Delightful animations to make the process feel rewarding

## Development

This app is developed with Vue 3, uses the Vite server, and requires [Node.js](https://nodejs.org/)/npm for installation. To set up a local development environment, first clone the repo, then run the following commands in the root directory:
This app is developed with Vue 3, uses the Vite server, and requires [Node.js](https://nodejs.org/) for installation. To set up a local development environment, first clone the repo, then run the following commands in the root directory:

```
npm install
Expand All @@ -21,6 +35,6 @@ npm run dev

This repo is configured with GitHub Actions to automatically build and deploy the `/dist` output. You can generate this folder locally for testing by running `npm run build`, and then `npm run preview` to serve it.

If you wish to fork this repo and also deploy to Github Pages, the config file `/.github/workflows/deploy.yml` will help you configure your own GitHub Actions. Other deployment targets such as Netlify can be found [in the Vite documentation](https://vitejs.dev/guide/static-deploy).
If you wish to fork this repo and also deploy to Github Pages, the config file `/.github/workflows/deploy.yml` will help you configure your own GitHub Actions. Other deployment targets such as Netlify are described [in the Vite documentation](https://vitejs.dev/guide/static-deploy).

If changing the repository name, you will need to update the base path in `vite.config.js`. For example if targeting a regular domain name without a subdirectory, `base` should be set to `/`, or simply deleted.
If changing the repository name, you will need to update the base path in `vite.config.js`. If targeting a regular domain name without a subdirectory, `base` should be set to `/` or simply deleted.

0 comments on commit b2a828b

Please sign in to comment.