nuxt.com

Welcome to the Nuxt website repository available on nuxt.com.

Setup

Make sure to enable corepack and install the dependencies:

corepack enable
pnpm install

Copy the .env.example file to .env:

cp .env.example .env

Clone/Fork nuxt/nuxt repo where you want (but not in the Nuxt.com project) and inside the root of the repo, run:

pwd

If you are on Windows, you can use the following command instead:

echo %cd%

Copy the output of the command above and paste it in the NUXT_PATH and NUXT_V4_PATH variables in the .env file.

Development

Start the development server:

pnpm dev

Add a Nuxt Template

To list a Nuxt template, add a file in the ./content/templates directory.

Make sure to start the development server in order to generate the screenshot for the template and go to http://localhost:3000/templates to see the result.

If you want to update the url where we take the automated screenshot, use the screenshotUrl property.

To regenerate the image, delete the generated one in public/assets/templates.

Production

In order to build the application for production, you need to have a Nuxt UI Pro license and set the NUXT_UI_PRO_LICENSE variable in the .env file.

Note that this is not required to run in development and contribute to the Nuxt website or documentation.

Build the application for production:

pnpm generate

Running Evals for the MCP Server

To run the evals for the MCP server, follow these steps:

1. Ensure your development server is running
   Start the local Nuxt development server:

   pnpm dev

2. Create an AI Gateway API key
   Go to https://vercel.com/ai-gateway and create an API key. Add the following variable to your .env file (replace sk-... with your actual key):

   AI_GATEWAY_API_KEY=<you-api-key>
   

3. Run the evals
   You can execute the evals from the command line:

   pnpm eval

   Or launch the interactive UI to run them via a web interface:

   pnpm eval:ui

License

MIT License