Skip to content

Latest commit

 

History

History
52 lines (41 loc) · 1.91 KB

README.md

File metadata and controls

52 lines (41 loc) · 1.91 KB
Raw

Fastyper

GitHub Stars GitHub Issues Live Demo

Screenshots

Game running

Demo

You can check out a fully working demo here

Setup

How to install and get the game up and running

First things first, let's install our frontend dependencies and build a production-ready bundle of our web app.

$ cd webapp
$ npm install
$ npm run build

Ok, now that we have our frontend ready, let's install our backend dependencies and start it!

$ cd ../api
$ npm install
$ npm start

Great! Now, if everything worked fine, we should be able to access the app at localhost:9000 :)

Get started

Guides, assuming the game is running at localhost:9000

Join a room

URL: localhost:9000/room/[ROOM_NAME]/username/[YOUR_USERNAME]
Example: Join the practicing room as IgorAntun: localhost:9000/room/practicing/username/IgorAntun

Get room status

URL: localhost:9000/room/[ROOM_NAME]/status
Example: Get status for the practicing room: localhost:9000/room/practicing/status

To do:

  • End game when 60s have passed
  • Game finished screen
  • Reset room state when game ends
  • Show diff between what was typed and original text (frontend)
  • Calculate score based on precision
  • Kick inactive users (afk)

License

You can check out the full license here

This project is licensed under the terms of the WTFPL license.
You just DO WHAT THE FUCK YOU WANT TO.