-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from nathanjessen/app-upgrade
App upgrade
- Loading branch information
Showing
32 changed files
with
13,933 additions
and
13,904 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,6 +20,6 @@ | |
.env.test.local | ||
.env.production.local | ||
|
||
# Logs | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
lerna-debug.log* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
20.9.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.