Welcome to the TicTacToe Multiplayer Game! This application allows multiple players to engage in the classic TicTacToe game in real-time.
- Real-Time Multiplayer: Play TicTacToe with friends or other players in real-time.
- User Authentication: Secure login and registration system to keep track of player statistics.
- Interactive UI: A user-friendly interface that enhances the gaming experience.
To set up the project locally, follow these steps:
- Clone the Repository:
git clone https://github.com/IsmailBinMujeeb/TicTacToe-MultiPlayer-Game.git
cd TicTacToe-MultiPlayer-Game
- Install Dependencies: Ensure you have Node.js and npm installed. Then, run:
npm install
- Set Up Environment Variables:
- Duplicate the .example.env file and rename the copy to .env.
cp .example.env .env
- Open the .env file and configure the following variables:
PORT=3000
SESSION_SECRET=
GOOGLE_CALLBACK_URL=
GOOGLE_CLIENT_ID=
GOOGLE_CLIENT_SECRET=
CLOUD_NAME=
CLOUDINARY_API_KEY=
CLOUDINARY_API_SECRET=
DB_CONN_STR=
REDIS_URL=
- Start the Application:
npm start
The server will start, and you can access the application at http://localhost:3000.
For those who prefer using Docker:
Docker Image
- Build the Docker Image:
docker build -t tictactoe-multiplayer-game .
- Run the Docker Container:
docker run -d -p 3000:3000 --name tictactoe-game tictactoe-multiplayer-game
- Or pull the image
docker pull ismailbinmujeeb/tic-tac-toe
The application will be available at http://localhost:3000.
- Start Services:
docker-compose up -d
This will set up the application along with any dependencies defined in the docker-compose.yml file.
We welcome contributions! If you'd like to contribute:
-
Fork the repository.
-
Create a new branch (git checkout -b feature/YourFeature).
-
Commit your changes (git commit -m 'Add YourFeature').
-
Push to the branch (git push origin feature/YourFeature).
-
Open a Pull Request.
Please ensure your code adheres to the project's coding standards and includes appropriate tests.