Skip to content

docs: Improve local setup guide #2420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: Improve local setup guide #2420

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,32 @@ $ bun install # install the dependencies
$ bun dev # start the development server
```

> **Note**
> If you don't have `bun` installed, you can use `npm` or `yarn` as an alternative.
>
> **Using `npm`:**
> ```bash
> $ npm install # install the dependencies
> $ npm run dev # start the development server
> ```
>
> **Using `yarn`:**
> ```bash
> $ yarn install # install the dependencies
> $ yarn dev # start the development server
> ```

The app should open in your browser.

## Troubleshooting

### `RollupError` on startup

When running the development server for the first time with `npm run dev`, you might encounter a `RollupError` related to the `nuxt-simple-sitemap` module. This is a known issue that can prevent the application from starting correctly.

To resolve this, you can temporarily disable the `nuxt-simple-sitemap` module.

1. Open the `nuxt.config.ts` file.
2. In the `modules` array, remove or comment out `'nuxt-simple-sitemap'`.
3. In the same file, remove the `site` configuration block if it exists.
4. Restart the development server (`npm run dev`).