Skip to content

Commit c36c8d5

Browse files
committed
docs: update readme and license
1 parent 01903d2 commit c36c8d5

File tree

2 files changed

+37
-57
lines changed

2 files changed

+37
-57
lines changed

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2023-PRESENT - Nuxt Team
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+16-57
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,34 @@
1-
# Nuxt 3 Minimal Starter
1+
# learn.nuxt.com
22

3-
Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
3+
> [!IMPORTANT]
4+
> This project is unfinished and heavily work in progress.
45
5-
## Setup
6+
An interactive Nuxt playground for learning Nuxt. Powered by [Nuxt](https://nuxt.com) and [WebContainers](https://webcontainers.io/).
67

7-
Make sure to install the dependencies:
8+
Inspired by [learn.svelte.dev](https://learn.svelte.dev).
89

9-
```bash
10-
# npm
11-
npm install
10+
## Live Streaming
1211

13-
# pnpm
14-
pnpm install
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).
1513

16-
# yarn
17-
yarn install
14+
## Development
1815

19-
# bun
20-
bun install
21-
```
16+
To run this project locally, you need to have [Node.js v20.0+](https://nodejs.org/en/) and [pnpm](https://pnpm.io/) installed.
2217

23-
## Development Server
24-
25-
Start the development server on `http://localhost:3000`:
18+
After cloning the repo, run the following commands to install dependencies:
2619

2720
```bash
28-
# npm
29-
npm run dev
30-
31-
# pnpm
32-
pnpm run dev
33-
34-
# yarn
35-
yarn dev
36-
37-
# bun
38-
bun run dev
21+
pnpm install
3922
```
4023

41-
## Production
42-
43-
Build the application for production:
24+
Then, run the following command to start the development server:
4425

4526
```bash
46-
# npm
47-
npm run build
48-
49-
# pnpm
50-
pnpm run build
51-
52-
# yarn
53-
yarn build
54-
55-
# bun
56-
bun run build
27+
pnpm dev
5728
```
5829

59-
Locally preview production build:
60-
61-
```bash
62-
# npm
63-
npm run preview
64-
65-
# pnpm
66-
pnpm run preview
30+
The development server will be running at [http://localhost:3000](http://localhost:3000).
6731

68-
# yarn
69-
yarn preview
70-
71-
# bun
72-
bun run preview
73-
```
32+
## License
7433

75-
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
34+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)