GeekyType

Hosted here

A typing app to practice typing and compete with your friends

Table Of Contents

• Built With
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• Authors

Built With

"GeekyType" is an exhilarating and educational multiplayer typing app built on the foundation of Next.js, Tailwind CSS, Node.js, MongoDB, and Socket.IO. This app offers users a thrilling journey through a gamified world of typing challenges, fostering an enjoyable and competitive atmosphere to improve their typing prowess.

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

• npm or yarn

Installation

1. Clone the repository to your local machine:

git clone https://github.com/Sidd-R/typing_app.git
cd typing_app
cd client

2. Install the required dependencies

npm install or yarn install

3. Install the required dependencies in server.

cd ..
cd server
npm install or yarn install
cd backend
npm install or yarn install

4. Set up the environment variables:

Create a .env file and add the below lines and replace it appropriate details
MONGODB_URI=your_mongodb_connection_string
SECRET_KEY=your_secret_key_for_jwt

Replace your_mongodb_connection_string with the connection string to your MongoDB database, and your_secret_key_for_jwt with a secure secret key for JWT token generation.

5. Start the development server for backend:

new terminal:
cd server
npm run dev or yarn dev

6. Start the development server for client:

cd client
npm run dev or yarn dev

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.

Authors

• Siddhant Rao - Siddhant Rao
• Satyam Jaiswal- Satyam Jaiswal
• Vikas Rajpurohit - Vikas Rajpurohit