shraddha-gawde/speedster

Speedster brings you a collection of exciting typing games crafted to turn practice into a joyful and effective experience. Whether you're a seasoned typist aiming to maintain speed or a beginner eager to improve, Speedster has tailored challenges for everyone. Explore our platform and embark on a journey to typing excellence.

About Speedster

Welcome to Speedster, your go-to platform for honing your typing skills and boosting your reading speed! Developed during our Unit 6 Construct Week, Speedster offers an engaging array of typing games designed to make practicing fun and effective. Whether you're a seasoned typist looking to maintain your speed or a beginner eager to improve, Speedster has something for you.

Project Type

Fullstack

Deplolyed App

Frontend: Live Link

Backend: Live Link

Directory Structure

my-app/
├─ backend/
│  ├─ controller/
│  │  ├─ middlewares/
│  │  ├─ routes/
│  ├─ models/
│  ├─ node_modules/
│  ├─ .env/
│  ├─ .gitignore/
│  ├─ db.js/
│  ├─ index.js/
│  ├─ package.json/
├─ frontend/
│  ├─ images/
│  ├─ public/
│  ├─ scripts/
│  ├─ styles/
│  ├─ view/
├─ index.html/

Video Walkthrough of the project

• Youtube

Features

• Typing games for improving typing speed and reading comprehension.
• Real-time multiplayer typing races.
• Various practice modes for typing paragraphs and words.
• Built a robust backend server using Node.js and the Express framework to handle user requests and authenticate users.
• Integrated MongoDB and Mongoose for efficient data storage and retrieval, ensuring seamless performance.
• Incorporated socket.io and websockets to provide real-time communication and interactive features on the platform

Design Decisions or Assumptions

• Utilized Bootstrap for responsive design to ensure compatibility across devices.
• Implemented MongoDB as the database for scalability and flexibility.
• Chose Express.js for the backend framework due to its simplicity and robustness.

Installation & Getting started

Detailed instructions on how to install, configure, and get the project running.

git clone https://github.com/your-username/speedster.git

Install dependencies:

cd speedster
npm install

Set up environment variables:

cp .env.example .env

Start the server:

npm run server

Credentials

Demo User:

• Username: shraddhagawde
• Password: Shraddha@1234

Usage How to use our project:

# Example
To start a typing race:
1. Navigate to the typing race section in the dashboard.
2. Click on "Start Race" to join a race or create a new one.
3. Once the race starts, type the given text as fast and accurately as possible.

Screenshots

Landing Page

Login/Registration Page

User Dashboard

Real Time Type Racing Module

Multiplayer Panel

Typing Practice (Paragraph)

Typing Practice (Words)

Learning Tools

Tech Stack

• HTML
• CSS
• JavaScript

Backend

• Node.js
• Express

Database

• MongoDB

External CSS library

• Bootstrap

Team Members

• Shraddha Gawde
• Aniket Baghel
• Deepak Kumar
• Shivam Oraon
• Vikas Yadav

---

Please ensure your code adheres to our coding standards and includes tests when applicable. Feel free to reach out if you have any questions or need further assistance. Happy coding!