WordVS

A 2-player puzzle game inspired by Wordle. The objective of the game is to guess a 6-letter mystery word and each player will take turns guessing.
I created this app to learn and practice different web technologies such as TypeScript, SocketIO, Next.JS, etc.

Table of Contents

1. About The Project
   • Front-end Built With
   • Back-end Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Running The App
3. Usage
4. Contact
5. Project Links

About The Project

(back to top)

Front-end Built With

Back-end Built With

(back to top)

Getting Started

Here are instructions to run the app locally.

Note Unfortunatley, there are typing issues that prevent the app from being built for deployment. These typing complications are due to implementing polymorphism and ES features not being recognized during the build. This is still a work in progress.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• yarn

  npm install --global yarn

Installation

1. Clone the repo for the front-end

   git clone https://github.com/Ovillena/wordvs.git

2. Clone the repo for the server

   git clone https://github.com/Ovillena/wordvs-server.git

   
3. Install packages

   cd wordvs
   yarn install
   cd ../wordvs-server
   yarn install

   

(back to top)

Running the app

1. To run the server, open a terminal window for the wordvs-server folder and run the command

   yarn start

   
2. To run the client, open a terminal window for wordvs folder and run the command

   yarn dev

   

(back to top)

Usage

1. Open 2 instances of localhost:3000 in the browser and enter the same room ID for both instances
2. Type in a few guesses to play the game
3. Click the chat button to enter the chat feature. Type in a message and press enter or click the arrow icon to send

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contact

• email: octaviovillena.ov@gmail.com
• LinkedIn: linkedin-url: https://linkedin.com/in/octavio-villena
• GitHub: https://github.com/Ovillena

(back to top)

Project Links

• https://github.com/Ovillena/wordvs
• https://github.com/Ovillena/wordvs-server

(back to top)