You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 1, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+13-10Lines changed: 13 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,26 +1,21 @@
1
1
# Nuxt Tutorial Playground
2
2
3
3
> [!WARNING]
4
-
> This project is unfinished and heavily work in progress.
4
+
> The architecture of this project is ready, while the tutorial content is still work in progress, contributions appreciated!
5
5
6
6
An interactive interactive tutorial and playground for learning Nuxt. Powered by [Nuxt](https://nuxt.com/docs) and [WebContainers](https://webcontainers.io/).
7
7
8
8
Inspired by [learn.svelte.dev](https://learn.svelte.dev).
9
9
10
+
`learn.nuxt.com` is not yet deployed, but you can preview the latest branch at [learn-dev.nuxt.com](https://learn-dev.nuxt.com).
11
+
10
12
## Live Streaming
11
13
12
-
Anthony Fu is doing regular live streaming on building this project from scratch. You can watch the recordings or join the live stream on [YouTube](https://www.youtube.com/playlist?list=PL4ETc_mXFfxUGiY852jH3ctljnI2e9Rax).
14
+
Anthony Fu built this project from scratch on Live Streaming. You can watch the recordings of the full process on [YouTube](https://www.youtube.com/playlist?list=PL4ETc_mXFfxUGiY852jH3ctljnI2e9Rax).
13
15
14
16
## Contributing
15
17
16
-
> [!IMPORTANT]
17
-
>
18
-
> **Please create an issue first before submitting PRs.**
19
-
> So that we can discuss about the directions and plans, to avoid wasted efforts. Thank you!
20
-
>
21
-
> This project is progressed mainly on Live Stream. In general, we want to present the main progress on the stream so people can follow along the whole process. Contributions are still greatly welcome! For PR that makes refactors or big changes, we could review them on the stream as well.
22
-
23
-
## Development
18
+
### Development
24
19
25
20
To run this project locally, you need to have [Node.js v20.0+](https://nodejs.org/en/) and [pnpm](https://pnpm.io/) installed.
26
21
@@ -38,6 +33,14 @@ pnpm dev
38
33
39
34
The development server will be running at [http://localhost:3000](http://localhost:3000).
40
35
36
+
### Content Structure
37
+
38
+
The tutorial content is located in the `content/` directory. Each route contains a number prefix (`1.`) to indicate the order and will be removed in the final URL. For each route, we use a folder with an `index.md` to serve the extra files. A `.template` folder can be placed with the `index.md` file to provide the template for the playground.
39
+
40
+
-`.template/index.ts` - Indicates the metadata for that guide, like enabling/disabling features, file filters, etc.
41
+
-`.template/files/**` - The files that will be copied to the playground when the user navigates to that guide, merged with the basic template under `template/basic/`
42
+
-`.template/solutions/**` - Optional solutions for the tasks in that guide, merged with the guide files.
0 commit comments