README.md

fabulous-vest-203

Typo Tales

Typo Tales is a typing platform that allows users to take part in typing by creating groups with their friends and also practice alone. This project is a clone of TypoTales.com and was built within 5 days by a team of 4 members.

Cloning of typeracer application

It is a collabrative project built by team of four members in 5 days.
This app allows users to enhance their typing skills and compitete among friends and family members and practice privetly  real-time.

Deployed Link

Frontend Link : https://cheerful-selkie-0b14c4.netlify.app/
Backend Link : https://typotales-hchv.onrender.com/

Features

Create groups with friends and compete against each other in real-time typing races Practice typing alone with various typing exercises and improve your typing skills View real-time progress of other users in your group during races Leaderboards to view top performers in races and exercises Authentication system to manage user accounts and sessions Responsive design for optimal user experience on all devices

Tech Stacks Used

NPM MODULES

{
    "express": "^4.18.2",
    "mongoose": "^7.0.3",
    "nodemon": "^2.0.22",
    "random-id": "^1.0.4",
    "server": "^1.0.38",
    "socket.io": "^4.6.1",
     "dotenv": "^16.0.3",
     REDIS
}

NPM Packages

Run Locally

Clone this Project

https://github.com/sriramalavalapati3/fabulous-vest-203.git

Install npm Packages

npm i --global

Go to Backend Folder

cd backend
cd index.js

Run Server

npm run server

### Runs the project in the development mode

[https://typotales-hchv.onrender.com](https://typotales-hchv.onrender.com)

Environment Variables Required

mongoURL

PORT

Redis Cloud Password + Host + Port

admin_tokenKey = adminToken

jwtnormalToken = yourToken

jwtrefreshToken = YourRefreshToken

Landing UI

Game UI

Register UI

Login UI

Authors

Sriram Alavalapati
Ashik Ansari
Vishal Padaswan
Saurabh Kumar Gupta