Skip to content

Commit

Permalink
Update project setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
marcaureln committed Jan 11, 2024
1 parent 175dda8 commit 5ba4bce
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,18 @@ Don't worry, if you don't need something, you can remove it.

## Setup

Yeah, yarn is better than npm. But you can still use npm if you want.

```bash
# Create a new Nuxt 3 project using this starter template:
npx nuxi init -t gh:inputstudio/nuxt3-starter <project-name>
# You can remove `--gitInit` if you don't want to initialize a Git repository.
# You can remove `--packageManager yarn` if you want to use another package manager.
npx nuxi init --gitInit --packageManager yarn -t gh:inputstudio/nuxt3-starter <project-name>
```

After the project is created (dependencies are already installed), you can run the following commands:

```bash
# Go to the project directory:
cd <project-name>
# Install the dependencies:
yarn install
# Start the development server:
yarn dev
```
Expand Down

0 comments on commit 5ba4bce

Please sign in to comment.