Skip to content

kstroevsky/websocket-clicker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

70 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

hivex-websocket-clicker

About

It is a web application based on React and bootstrapped with Create React App. This project provide multiplayer ability to a simply Clicker (Counter) functionality with WebSockets API provided as Socket.IO library. You can create user, game (with room limit and duration) and join the game by another user (i.e. by another browser).

Current goals

  • add style switching (issue #9)
  • add more tests (issue #11)
  • try to move the project from socket.io to WebSocket API (issue #15)
  • try to dockerize project (issue #14)
  • deploy on heroku/vercel (issue #10)

Contributing

Unfortunately, now we haven't enough tests and testing pipeline or another CI-pipelines. But we add their soon (issue #11).

Getting Started

Backend

Open the first terminal tab and use follow instructions:

install requirements packages

  • nodemon: npm install -g nodemon or yarn global add nodemon
  • other: npm install or yarn

dev mode

yarn dev or npm run dev

product mode

yarn start or npm run start

Frontend

Open the second terminal tab and use follow instructions:

  • cd client

short:

  • npm install or yarn
  • npm run start or yarn start

long:

See here: Frontend README