Code Monkey home page Code Monkey logo

drawandguess-be's Introduction

DrawAndGuess-BE

Simple Monolithic Backend for Draw and Guess Game using Node.js, Typescript, Mongo DB, Express and Web Sockets. It also supports multiplayer.

How to Run?

In order to run directly on your system, you must have installed NPM, Node.js and MongoDB on your system.

Since it uses Bcrypt, you are required to install:

  • node-gyp and python on Linux based systems.
  • Additionally C# and C++ would be needed for Windows Users.

Can further check out instructions on Bcrypt's Github page.

From the terminal in the root of the project, run the following command:

npm run dev

Using Docker

Above sounds too much? 👀

✨Docker Compose✨ to the rescue!

Run following from the root of the project, and you should be good!

docker-compose up --build

About

  • There is no authentication in the app. When user opens the app for the first time, a guest user is created in the DB.

  • Main routes of the app are as follows:

  • Words are seeded into DB when server is started.

  • Web Sockets have been used for communication between different users.

  • The user who creates the room is Admin as well as master, that broadcasts to other users about timely events such as timer start, next turn, navigation etc.

You can check sockets event management here.

Information ℹ️

These APIs have been created for the Kotlin Compose Multiplatform Mobile game which you can check here.

drawandguess-be's People

Contributors

blueberry404 avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

gujjula555

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.