Skip to content

Wordle mustapha jlem #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MT-jlem wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Wordle mustapha jlem #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
89bf39c
project init
MT-jlem Aug 7, 2024
a2f21fc
added basic ui and game logic
MT-jlem Aug 8, 2024
6fc91cc
added win/lose modal, basic loading ui
MT-jlem Aug 9, 2024
1ab1a0e
added submit button, change loading, fix ui
MT-jlem Aug 9, 2024
52a0f5f
rm unnecessary css
MT-jlem Aug 9, 2024
3ddba44
added animation to rows
MT-jlem Aug 11, 2024
9e5ac56
added documentation
MT-jlem Aug 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions Wordle/.eslintrc.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
module.exports = {
root: true,
env: { browser: true, es2020: true },
extends: [
'eslint:recommended',
'plugin:@typescript-eslint/recommended',
'plugin:react-hooks/recommended',
],
ignorePatterns: ['dist', '.eslintrc.cjs'],
parser: '@typescript-eslint/parser',
plugins: ['react-refresh'],
rules: {
'react-refresh/only-export-components': [
'warn',
{ allowConstantExport: true },
],
},
}
24 changes: 24 additions & 0 deletions Wordle/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*

node_modules
dist
dist-ssr
*.local

# Editor directories and files
.vscode/*
!.vscode/extensions.json
.idea
.DS_Store
*.suo
*.ntvs*
*.njsproj
*.sln
*.sw?
43 changes: 43 additions & 0 deletions Wordle/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Wordle Game

This is a Wordle-inspired game built using React and Tailwind CSS.

## Installation

To run this project locally:

1. Clone the repository:

```bash
git clone https://github.com/MT-jlem/OpenDevEd-Wordle &&
git checkout wordle-mustapha-jlem &&
cd wordle-game
```

2. Install the dependencies:

```bash
npm install
```

3. Start the development server:

```bash
npm run dev
```

## Development Approach

I started by implementing the game logic and creating a basic UI to test and iterate on. My first focus was handling user input, which included capturing keyboard events and processing the input to form a guess.

### Input Validation

To validate the input, I needed to ensure that the guessed words were valid. Initially, I considered setting up a backend service for this purpose, but given the scope of the project, I decided to use a third-party API for word validation instead. This allowed me to quickly implement the feature without the overhead of managing a backend.

### State Management

As the project grew, I needed to share state across different components, particularly for managing the game's progress (e.g., guesses, attempts). To keep things simple and avoid unnecessary complexity, I chose the Context API for state management. While there are dedicated state management libraries available, I felt that using one would be overkill for this project given its scale.

### Feedback and UI Enhancements

After setting up the core functionality, I focused on providing feedback to the user when submitting a word. This included visual cues for correct and incorrect guesses, as well as handling edge cases like invalid words or duplicate submissions. To enhance the user experience, I added animations and UI improvements using Tailwind CSS, making the game more engaging and responsive.
13 changes: 13 additions & 0 deletions Wordle/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Wordle</title>
</head>
<body>
<div id="root"></div>
<script type="module" src="/src/main.tsx"></script>
</body>
</html>
Loading