deewhy/pacman repository overview

⁠🕹️ Pac-Man: Classic Arcade Game

This project is a containerized version of the classic Pac-Man arcade game. It features a persistent scoreboard powered by Google Firebase Firestore and is designed to be fully desktop and mobile friendly.

⁠Project Details

• Game Logic: HTML5 Canvas / JavaScript
• Backend/Server: Node.js (server.js)
• Database: Firebase Firestore (for Scoreboard persistence)
• Deployment: Docker
• Compatibility: Fully Responsive (Desktop, Tablet, and Mobile devices).

⁠Features

• Classic Gameplay: Smooth, responsive Pac-Man action with faithful mechanics.
• Responsive Design: Optimized controls and display for various screen sizes, ensuring a great experience on both mobile and desktop.
• Real-Time Scoreboard: High scores are tracked and displayed using a real-time listener from Firebase Firestore.
• Containerized: Easy to run and scale using Docker.

⁠Setup & Running Locally

⁠1. Prerequisites

You must have the following installed:

• Node.js⁠ and npm
• Docker⁠

⁠2. Configure Firebase (Scoreboard)

1. Create a Firebase Project: Set up a new project in the Google Firebase Console.

2. Enable Firestore: Initialize the Firestore Database for your project.

3. Get Configuration: Retrieve your Firebase configuration object (API Key, Project ID, etc.).

4. Update .env: Create a .env file in the root of the project to hold your configuration:

   # Example .env file
   FIREBASE_API_KEY="AIzaSy..."
   FIREBASE_PROJECT_ID="your-project-id"
   # ... add other Firebase configuration fields
   PORT=3010
   

   Copy

   (Note: This file should be excluded by your .gitignore for security)

⁠3. Build and Run with Docker

1. Build the Docker Image:

   docker build -t pacman .
   

   Copy

2. Run the Container:

   docker run -d --name pacman -p 3010:3010 pacman
   

   Copy

The game will be accessible in your web browser at http://localhost:3010.

⁠Deployment to Docker Hub

This image is available publicly on Docker Hub under the deewhy namespace:

docker pull deewhy/pacman:latest