TypeBattle.com

TypeBattle is a multiplayer online browser-based typing game. In TypeBattle, players complete typing tests of various texts as fast as possible, competing against themselves or with other users online

Features

• Authentication
• Authorization
• Responsive
• Cross platform

Tech Stack

Framework: Vite

Client: HTML, CSS, JavaScript

Server: Node.js, Express.js, Socket.io

Database: MongoDB, Redis

Run Locally

Clone the project

  git clone https://github.com/faraz412/acceptable-straw-3421

Go to the project directory

  cd acceptable-straw-3421

Install dependencies

  npm install

Start the server

  node index.js

Environment Variables

To run this project, you will need to add the following environment variables to your .env file

key

mongourl

PORT

API base URL (local vs deployed)

Edit urls.config.js at the project root:

• environment: "local" — http://localhost:1337 (use while testing)
• environment: "deployed" — https://type-battle.onrender.com (use before pushing)

All client API and Socket.io calls read from this file via client/public/scripts/baseURL.js.

API Reference

Welcome

  GET /api

User Register

  POST /api/user/register

User Login

  POST /api/user/login

Admin Register

  POST /api/admin/register

Admin Login

  POST /api/admin/login

All Content

  GET /api/content/

Add Content

  POST /api/content/addcontent

Update Content

  PATCH /api/content/update/:id

Delete Content

  DELETE /api/content/delete/:id

Screenshots

Demo

https://type-battle.onrender.com/

Authors

• @DanteHaxor
• @Abhinav068
• @shanukajain
• @faraz412
• @sarveshgupta1997