Skip to content

Commit e39e56c

Browse files
committed
chore: init
0 parents  commit e39e56c

25 files changed

Lines changed: 11338 additions & 0 deletions

.github/copilot-instructions.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Core Requirements
2+
3+
- The end goal is stability, speed and great user experience.
4+
5+
## Code Quality Requirements
6+
7+
- Follow standard TypeScript conventions and best practices
8+
- Use the Composition API when creating Vue components
9+
- Use clear, descriptive variable and function names
10+
- Accessibility should always be a first-class consideration and should be part of the initial planning and design.
11+
- Add comments only to explain complex logic or non-obvious implementations
12+
- Write unit tests for core functionality using `vitest`
13+
- Write end-to-end tests using Playwright and `@nuxt/test-utils`
14+
- Keep functions focused and manageable (generally under 50 lines)
15+
- Use error handling patterns consistently
16+
- Ensure you write strictly type-safe code, for example by ensuring you always check when accessing an array value by index

.github/workflows/autofix.yml

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# needed to securely identify the workflow
2+
name: autofix.ci
3+
4+
on:
5+
pull_request:
6+
branches:
7+
- main
8+
9+
permissions:
10+
contents: read
11+
12+
jobs:
13+
code:
14+
runs-on: ubuntu-latest
15+
16+
steps:
17+
- uses: actions/checkout@v6
18+
- run: npm i -g --force corepack && corepack enable
19+
- uses: actions/setup-node@v6
20+
with:
21+
node-version: lts/*
22+
cache: "pnpm"
23+
24+
- name: 📦 Install dependencies
25+
run: pnpm install
26+
27+
- name: 📦 Install browsers
28+
run: pnpm playwright install
29+
30+
- name: 🔠 Fix lint errors
31+
run: pnpm lint --fix
32+
33+
- name: 🧪 Update unit test snapshots
34+
run: pnpm test:unit -u
35+
36+
- name: 🏃 Update component test snapshots
37+
run: pnpm test:nuxt -u
38+
39+
- name: 🖥️ Update browser test snapshots
40+
run: pnpm test:browser --update-snapshots
41+
42+
- uses: autofix-ci/action@635ffb0c9798bd160680f18fd73371e355b85f27

.github/workflows/ci.yml

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: ci
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- main
7+
push:
8+
branches:
9+
- main
10+
11+
jobs:
12+
lint:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- uses: actions/checkout@v6
17+
- run: npm i -g --force corepack && corepack enable
18+
- uses: actions/setup-node@v6
19+
with:
20+
node-version: lts/*
21+
cache: pnpm
22+
23+
- name: 📦 Install dependencies
24+
run: pnpm install
25+
26+
- name: 🔠 Lint project
27+
run: pnpm lint
28+
29+
test:
30+
runs-on: ubuntu-latest
31+
32+
steps:
33+
- uses: actions/checkout@v6
34+
- run: npm i -g --force corepack && corepack enable
35+
- uses: actions/setup-node@v6
36+
with:
37+
node-version: lts/*
38+
cache: pnpm
39+
40+
- name: 📦 Install dependencies
41+
run: pnpm install
42+
43+
- name: 💪 Type check
44+
run: pnpm test:types
45+
46+
- name: 🧪 Unit test
47+
run: pnpm test:unit
48+
49+
- name: 🏃 Component tests
50+
run: pnpm test:nuxt
51+
52+
browser:
53+
runs-on: ubuntu-latest
54+
container:
55+
image: mcr.microsoft.com/playwright:v1.57.0-noble
56+
57+
steps:
58+
- uses: actions/checkout@v6
59+
- run: npm i -g --force corepack && corepack enable
60+
- uses: actions/setup-node@v6
61+
with:
62+
node-version: lts/*
63+
cache: pnpm
64+
65+
- name: 📦 Install dependencies
66+
run: pnpm install
67+
68+
- name: 🖥️ Test project (browser)
69+
run: pnpm test:browser

.github/workflows/provenance.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: ci
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
permissions:
11+
contents: read
12+
jobs:
13+
check-provenance:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v6
17+
with:
18+
fetch-depth: 0
19+
- name: Check provenance downgrades
20+
uses: danielroe/provenance-action@41bcc969e579d9e29af08ba44fcbfdf95cee6e6c # v0.1.1
21+
with:
22+
fail-on-provenance-change: true

.gitignore

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Nuxt dev/build outputs
2+
.output
3+
.data
4+
.nuxt
5+
.nitro
6+
.cache
7+
dist
8+
9+
# Node dependencies
10+
node_modules
11+
.pnpm-store
12+
13+
# Logs
14+
logs
15+
*.log
16+
17+
# Misc
18+
.DS_Store
19+
.fleet
20+
.idea
21+
22+
# Local env files
23+
.env
24+
.env.*
25+
!.env.example
26+
27+
# Testing
28+
test-results
29+
30+
# Test coverage
31+
coverage/
32+
33+
# Playwright
34+
playwright-report/
35+
test-results/

.nuxtrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
setups.@nuxt/test-utils="3.23.0"

README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Nuxt 3 Minimal Starter
2+
3+
Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
4+
5+
## Setup
6+
7+
Make sure to install the dependencies:
8+
9+
```bash
10+
# npm
11+
npm install
12+
13+
# pnpm
14+
pnpm install
15+
16+
# yarn
17+
yarn install
18+
19+
# bun
20+
bun install
21+
```
22+
23+
## Development Server
24+
25+
Start the development server on `http://localhost:3000`:
26+
27+
```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
39+
```
40+
41+
## Production
42+
43+
Build the application for production:
44+
45+
```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
57+
```
58+
59+
Locally preview production build:
60+
61+
```bash
62+
# npm
63+
npm run preview
64+
65+
# pnpm
66+
pnpm run preview
67+
68+
# yarn
69+
yarn preview
70+
71+
# bun
72+
bun run preview
73+
```
74+
75+
Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.

app/app.vue

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<script setup lang="ts">
2+
defineOgImage()
3+
4+
useSeoMeta({
5+
title: 'Nuxt Starter',
6+
})
7+
</script>
8+
9+
<template>
10+
<div>
11+
<NuxtPage />
12+
</div>
13+
</template>

app/pages/index.vue

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<template>
2+
<div>
3+
Nuxt site template
4+
<NuxtLink to="/">
5+
Home
6+
</NuxtLink>
7+
</div>
8+
</template>

eslint.config.mjs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
// @ts-check
2+
import withNuxt from './.nuxt/eslint.config.mjs'
3+
4+
export default withNuxt(
5+
// Your custom configs here
6+
)

0 commit comments

Comments
 (0)