danielroe.dev
[READ-ONLY] Mirror of https://github.com/danielroe/n3rdle.
n3rdle.vercel.app
docs: add README (#3)
author
Daniel Roe
committer
GitHub
date
(Mar 15, 2022, 4:00 PM UTC)
commit
e4d85c5e
e4d85c5e5c3ff36e30c445c0bcfc76e781cb7738
parent
a9b500bc
a9b500bc88833947c12e0fc5172c4d40bfade340
+55
+55
README.md
+55
README.md
···
1
+
# Nuxt 3 + Wordle (n3rdle)
2
+
3
+
This is a tiny, incomplete clone of Wordle built in [Nuxt 3](https://v3.nuxtjs.org/) for a live-coding session at [Vue.js Nation 2022](https://vuejsnation.com/).
4
+
5
+
<p align="center">
6
+
<a href="https://n3rdle.vercel.app/" target="_blank">
7
+
<img width="1090" alt="Screenshot of a Wordle game in progress" src="https://raw.githubusercontent.com/danielroe/n3rdle/376875b3966029f80f5ed765f994e5a3235214e5/screenshot.png">
8
+
<br>
9
+
Live Demo
10
+
</a>
11
+
</p>
12
+
13
+
- [✨ Live Demo](https://n3rdle.vercel.app/)
14
+
- [🔈 Talk](https://www.youtube.com/watch?v=-U8NWGTGNVw)
15
+
16
+
## Features
17
+
18
+
- Based on [Nuxt 3](https://v3.nuxtjs.org/)
19
+
- Server API routes using [Nuxt Nitro](https://v3.nuxtjs.org/concepts/server-engine)
20
+
- Usage of [composables](https://v3.nuxtjs.org/docs/directory-structure/composables)
21
+
- Persists an anonymous session
22
+
- Light & dark mode using [pico.css](https://picocss.com/docs/)
23
+
24
+
## Try it out
25
+
26
+
### Setup
27
+
28
+
```bash
29
+
# install dependencies
30
+
npm install # or yarn
31
+
32
+
# serve in dev mode, with hot reload at localhost:3000
33
+
npm run dev
34
+
35
+
# build for production (universal)
36
+
npm run build
37
+
38
+
# preview in production mode
39
+
npm start
40
+
```
41
+
42
+
### Deployment
43
+
44
+
You should be able to deploy this repository with zero or minimal configuration.
45
+
46
+
- [Azure](https://v3.nuxtjs.org/docs/deployment/azure)
47
+
- [Cloudflare Workers](https://v3.nuxtjs.org/docs/deployment/cloudflare)
48
+
- [Firebase Hosting](https://v3.nuxtjs.org/docs/deployment/firebase)
49
+
- [Netlify](https://v3.nuxtjs.org/docs/deployment/netlify)
50
+
- [Vercel](https://v3.nuxtjs.org/docs/deployment/vercel)
51
+
- ... and more
52
+
53
+
## License
54
+
55
+
MIT
screenshot.png
screenshot.png
This is a binary file and will not be displayed.