opusc / speed-wordle

Wordle but on a timer

React Native Expo Project

Welcome to the React Native Expo project repository! This project is built using React Native and Expo, allowing you to develop and test your mobile applications seamlessly on both iOS and Android devices. This readme file provides an overview of the project and instructions to get you started.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
• Running the App
• Build
• Contributing
• License

Getting Started

Prerequisites

Before you start, make sure you have the following tools installed:

• Node.js (LTS version recommended)
• Yarn - Yarn is a package manager that we'll use instead of npm.
• Expo CLI - Install Expo CLI globally using yarn:

  yarn global add expo-cli

Installation

1. Clone this repository to your local machine using:

   git clone https://github.com/OpusC/Speed-Wordle.git

2. Change directory to the project folder:

   cd Speed-Wordle

3. Install project dependencies using Yarn:

   yarn install

Running the App

To run the app on your local development server, use the following Expo CLI command:

expo start

This will start the Expo development server and open the Expo Developer Tools in your default web browser. From there, you can choose to run the app on an iOS/Android simulator or scan the QR code with the Expo Go app on your physical device.

Build

To create a standalone build for iOS and Android, you can use Expo CLI's build commands. Refer to the Expo documentation for detailed instructions on building your app.

Contributing

We welcome contributions to this project! If you find any bugs or want to add new features, please feel free to create issues or submit pull requests. Make sure to follow the coding guidelines and create descriptive commit messages for better collaboration.

License

This project is licensed under the MIT License. You are free to use, modify, and distribute the code as per the terms of the license. See the LICENSE file for more details.

speed-wordle's Issues

Timer begins without a proper guess

Timer starts for a game even if the word is not a valid word, or incorrect length

Add timer

Implement a timer to the application. Game should result in a loss if timer reaches 0

Countdown timer reset bug

Timer does not reset properly when maximum guesses are made

Menu incomplete

Add option to change the max duration of the timer through the menu. Also to switch to a timed mode that counts up, and saves your time for the word of the day solve.

Edit: Switch max time implemented

Remaining:

Change to count up mode

Add hard mode toggle