Giter Club home page Giter Club logo

cockroach-poker's Introduction


Cockroach Poker - A Bluff Game

Introducing Cockroach Poker Plus: The Ultimate Bluffing App! The app is powered by Next.Js and Firebase. The app is based on Sockets to enable the multiplayer functionality. Users can join, get random names and avatars and share the room IDs with their friends and let the party started.

Engage in thrilling multiplayer matches with friends or random opponents. Experience the excitement of bluffing and guessing in real-time while leveraging the power of Firebase for secure user data storage, and real-time updates.


                       

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contact

About The Project

This project is an Single Page Web App Next JS by Vercel.

Ofcourse, the Game doesn't serve for many users will. You may check-out my Roadmap for the Web App here. You may also suggest changes or new features by creating a new issue here.

(back to top)

Built With

Below is the list of all the major frameworks and libraries used in the project.

(back to top)

Getting Started

To get a local copy of the Web App up and running follow these simple steps

  • Clone the repository
git clone https://github.com/himakhaitan/Cockroach-Poker.git
  • Install the dependencies
npm install
npm run start
  • For Development Mode
npm run dev

This will constantly look for changes in your code and restart the server automatically. Rescued Huhh!

(back to top)

Prerequisites

The prerequisites for the API server to run are the following:

  • Node.js (v16.16.0 or higher)
  • and you are good to go!

(back to top)

Installation

Following are the steps to configure the Web APP and make it up and running.

  • Configure the Environment Variables
    • Create a file called .env in the root directory of the project
    • Add the following lines to the file
    FIREBASE_API_KEY=
    FIREBASE_AUTH_DOMAIN=
    FIREBASE_DATABASE_URL=
    FIREBASE_PROJECT_ID=
    FIREBASE_STORAGE_BUCKET=
    FIREBASE_MESSAGING_SENDER_ID=
    FIREBASE_APP_ID=
    FIREBASE_MEASUREMENT_ID=
    • Note: You can also use the sample.env file to get a template of the file

(back to top)

Roadmap

  • Adding Custom Names and Avatars for the Users
  • Routes for Visitors who wanna Spectate
  • Text Chat while the game is running
  • Authenticate users using Firebase

See the open issues for a full list of proposed features (and known issues). Feel free to create one.

(back to top)

Contact

Feel free to reach me out on any of the above mediums (LinkedIn, Mail and Twitter for fast responses). See you in my inbox / DMs 📩 😃

          

(back to top)

Hapilly turning Coffee into Code ☕️ 💻

cockroach-poker's People

Contributors

himakhaitan avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.