TypingGame (For developers)

Test your typing skills the right way!

This mini-game is designed and structured to help you improve your typing speed and accuracy in coding.

🚀 Features

• 1-Minute timer
• Code-like text structure
• Mistakes counter

🛠️ Tech Stack

• Frontend: Vite, React, Zustand, Tailwind, TypeScript
• Backend: Node.js, Express
• Database: PostgreSQL

🏁 Getting Started

Prerequisites

• Node.js (v18+ recommended)
• PostgreSQL installed and running

Installation & Setup

1. Clone the repository:

   git clone https://github.com/Boostry123/TypingGame.git
   cd TypingGame

2. Set up the Backend:

   • Navigate to the backend/server directory:

     cd server

   • Install dependencies:

     npm install

Create a .env file in the /server directory

 touch .env

Add the following content, replacing with your values

# Server Port

PORT=3001

# PostgreSQL Database Connection

DB_USER=postgres
DB_HOST=localhost
DB_DATABASE=typing_game_db # Or whatever you named it
DB_PASSWORD=your_password
DB_PORT=5432

Server Configuration

PORT=3001

• DataBase You can add your own text files using the api calls with Postman , If you want some examples you will find them in the server/seed/snippets.json
  • Start the server:

    npm run dev

3. Set up the Frontend:

   • Navigate to the frontend/client directory (from the root):

     cd ../client

   • Install dependencies:

     npm install

   • Start the client:

     npm run dev

4. Open http://localhost:5173 (or your Vite port) in your browser.

🌐 Some screenshots of the project in use

🗘 Expected Updates:

• Add more stores
• Add first setup script to populate example snippets (seeding)
• Simple Users system and Auth