Skip to content

Commit

Permalink
Merge pull request #1 from nathanjessen/app-upgrade
Browse files Browse the repository at this point in the history
App upgrade
  • Loading branch information
nathanjessen authored Nov 29, 2024
2 parents cd58509 + 775cf40 commit 611a5b8
Show file tree
Hide file tree
Showing 32 changed files with 13,933 additions and 13,904 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@
.env.test.local
.env.production.local

# Logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
20.9.0
64 changes: 51 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,75 @@
# wordle

Wordle game built with React and DaisyUI
A Wordle clone built with React and Tailwind CSS. Challenge yourself to guess the hidden word in this engaging word puzzle game.

This project uses [Vite](https://vitejs.dev/).
## 🚀 Live Demo

## Environments
- **Game**: [https://wordle.nathanjessen.com/](https://wordle.nathanjessen.com/)
- **Storybook**: [https://nathanjessen.com/wordle/](https://nathanjessen.com/wordle/)

Storybook docs are deployed to the docs branch using a GitHub action workflow. They can be viewed at [https://nathanjessen.com/wordle/](https://nathanjessen.com/wordle/).
## 🛠️ Tech Stack

The production app is deployed to [https://wordle.nathanjessen.com/](https://wordle.nathanjessen.com/) using [https://vercel.com](Vercel).
- [React](https://reactjs.org/) - UI Framework
- [Vite](https://vitejs.dev/) - Build Tool
- [TypeScript](https://www.typescriptlang.org/) - Language
- [Tailwind CSS](https://tailwindcss.com/) - Styling
- [Storybook](https://storybook.js.org/) - Component Development

## Available Scripts
## 🏗️ Development

In the project directory, you can run:
### Prerequisites

### `yarn dev`
- Node.js 20.9.0 or higher
- npm 10.1.0 or higher

### Getting Started

1. Clone the repository
```bash
git clone https://github.com/nathanjessen/wordle.git
cd wordle
```

2. Install dependencies
```bash
npm install
```

3. Start the development server
```bash
npm run dev
```

## 📜 Available Scripts

### `npm run dev`

Start Vite dev server in the current directory. Will enter the watch mode in development environment and run mode in CI automatically.

The page will reload if you make edits.

### `yarn build`
### `npm run build`

Builds the app for production to the `dist` folder. [yarn build](https://vitejs.dev/guide/cli.html#build)
Builds the app for production to the `dist` folder. [npm run build](https://vitejs.dev/guide/cli.html#build)

### `yarn preview`
### `npm run preview`

Locally preview production build. [vite preview](https://vitejs.dev/guide/cli.html#vite-preview)

### `yarn storybook`
### `npm run storybook`

Start the Storybook dev server for building components in isolation.

### `yarn build-storybook`
### `npm run build-storybook`

Builds the storybook app for production.

## 🚀 Deployment

The application is deployed using [Vercel](https://vercel.com). The production app is available at [https://wordle.nathanjessen.com/](https://wordle.nathanjessen.com/).

Storybook documentation is automatically deployed to the docs branch using GitHub Actions and can be viewed at [https://nathanjessen.com/wordle/](https://nathanjessen.com/wordle/).

## 📝 License

This project is open source and available under the [MIT License](LICENSE).
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<meta name="theme-color" content="#000000" />
<meta
name="description"
content="Wordle game built with React and DaisyUI"
content="Wordle game built with React and Tailwind CSS"
/>
<link rel="apple-touch-icon" href="/logo192.png" />
<!--
Expand Down
Loading

0 comments on commit 611a5b8

Please sign in to comment.