Skip to content

Latest commit

 

History

History
72 lines (53 loc) · 2.65 KB

README.md

File metadata and controls

72 lines (53 loc) · 2.65 KB
Raw

JustBingo - Easy Configurable Bingo

JustBingo

JustBingo is a web application built with JavaScript and Express that allows you to create, play, and configure a bingo grid in no time.

Features

Bingo Grid

  1. Simple and Straightforward Design: User-friendly interface for an enjoyable experience.
  2. Right Click to Disable a Field: Easily manage your bingo fields with a simple right-click.
  3. Fast and Configurable: Quick setup and configuration to suit your needs.
  4. Import and Export Word Lists as JSON: Seamlessly manage your bingo words.
  5. Multiple Field Types: Flexibility to create various types of fields.
  6. Perfect for Every Daily Standup: Make your daily meetings more engaging and fun!

Self-hosting

Natively

  1. Setup Environment: Rename the .env.template file to .env and configure the IP, Port, and Admin login credentials as needed.
  2. Install Dependencies: Run the following command to install all necessary npm packages: 
    npm install
  3. Start the Application: Launch the app with: 
    npm start

In Docker

Alternatively you can run the application in Docker. To do so, first build the container:

docker build -t justbingo:latest .

Then run the container:

docker run --init --name justbingo -p 127.0.0.1:3000:3000 -e ADMIN_PASSWORD=hunter2 justbingo:latest

By default the application will bind to any interface in the container, which should be suitable for most deployment scenarios and allows to directly expose it on a port of the host machine.

You can customize aspects of the application by overriding the set of environment variables which are listend in the .env.template file, as shown above with the admin password.

To automatically load the set of configured bingo tiles, you can mount a words.json file, as generated by the application's "export JSON" function, to /usr/src/app/words.json in the container.

Developing

  1. Environment Configuration: The .env file is optional. The app defaults to localhost:3000, with the default admin login as admin and password as password.
  2. Install Packages: Install required packages using: 
    npm install
  3. Run the Application: Start the app using: 
    node .

Contribution

Contributions are welcome! Feel free to submit a pull request or open an issue if you have suggestions or improvements.

License

This project is licensed under the MIT License. See the LICENSE file for more details.