Skip to content

Commit aa2ff59

Browse files
committed
initial commit
1 parent 09308c7 commit aa2ff59

58 files changed

Lines changed: 32441 additions & 6133 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/check.yml

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: Check
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
concurrency:
10+
group: ${{ github.workflow }}-${{ github.ref }}
11+
cancel-in-progress: true
12+
13+
jobs:
14+
lint:
15+
name: Lint
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v4
19+
20+
- uses: oven-sh/setup-bun@v2
21+
with:
22+
bun-version: latest
23+
24+
- name: Install dependencies
25+
run: bun install
26+
27+
- name: Run oxlint
28+
run: bun run lint
29+
30+
format:
31+
name: Format
32+
runs-on: ubuntu-latest
33+
steps:
34+
- uses: actions/checkout@v4
35+
36+
- uses: oven-sh/setup-bun@v2
37+
with:
38+
bun-version: latest
39+
40+
- name: Install dependencies
41+
run: bun install
42+
43+
- name: Check formatting
44+
run: bun run fmt:check
45+
46+
typecheck:
47+
name: Type Check
48+
runs-on: ubuntu-latest
49+
steps:
50+
- uses: actions/checkout@v4
51+
52+
- uses: oven-sh/setup-bun@v2
53+
with:
54+
bun-version: latest
55+
56+
- name: Install dependencies
57+
run: bun install
58+
59+
- name: Run type check
60+
run: bun run typecheck
61+
62+
build:
63+
name: Build
64+
runs-on: ubuntu-latest
65+
steps:
66+
- uses: actions/checkout@v4
67+
68+
- uses: oven-sh/setup-bun@v2
69+
with:
70+
bun-version: latest
71+
72+
- name: Install dependencies
73+
run: bun install
74+
75+
- name: Build
76+
run: bun run build
77+
78+
test:
79+
name: Test
80+
runs-on: ubuntu-latest
81+
steps:
82+
- uses: actions/checkout@v4
83+
84+
- uses: oven-sh/setup-bun@v2
85+
with:
86+
bun-version: latest
87+
88+
- name: Install dependencies
89+
run: bun install
90+
91+
- name: Run tests
92+
run: bun run test:run

.github/workflows/deploy.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: true
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
steps:
21+
- uses: actions/checkout@v4
22+
23+
- uses: oven-sh/setup-bun@v2
24+
with:
25+
bun-version: latest
26+
27+
- name: Install dependencies
28+
run: bun install
29+
30+
- name: Generate static site
31+
run: bun run generate
32+
33+
- uses: actions/upload-pages-artifact@v3
34+
with:
35+
path: .output/public
36+
37+
deploy:
38+
needs: build
39+
runs-on: ubuntu-latest
40+
environment:
41+
name: github-pages
42+
url: ${{ steps.deployment.outputs.page_url }}
43+
steps:
44+
- uses: actions/deploy-pages@v4
45+
id: deployment

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,10 @@ logs
2222
.env
2323
.env.*
2424
!.env.example
25+
26+
# VS Code
27+
.vscode/*
28+
!.vscode/extensions.json
29+
30+
*storybook.log
31+
storybook-static

.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"

.oxlintrc.json

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/oxc-project/oxc/main/npm/oxlint/configuration_schema.json",
3+
"rules": {
4+
"no-unused-vars": "error",
5+
"no-console": "warn",
6+
"eqeqeq": "error",
7+
"no-var": "error",
8+
"prefer-const": "error",
9+
"no-eval": "error",
10+
"no-implied-eval": "error",
11+
"no-new-func": "error",
12+
"no-return-await": "error",
13+
"no-throw-literal": "error",
14+
"no-useless-catch": "error",
15+
"no-useless-return": "error",
16+
"no-empty": "error",
17+
"no-empty-function": "warn",
18+
"no-duplicate-imports": "error",
19+
"no-self-compare": "error",
20+
"no-template-curly-in-string": "warn",
21+
"no-unreachable": "error",
22+
"no-unsafe-negation": "error",
23+
"no-constant-condition": "error",
24+
"no-debugger": "error",
25+
"no-dupe-keys": "error",
26+
"no-duplicate-case": "error",
27+
"no-ex-assign": "error",
28+
"no-extra-boolean-cast": "error",
29+
"no-func-assign": "error",
30+
"no-inner-declarations": "error",
31+
"no-invalid-regexp": "error",
32+
"no-irregular-whitespace": "error",
33+
"no-obj-calls": "error",
34+
"no-sparse-arrays": "error",
35+
"no-unexpected-multiline": "error",
36+
"use-isnan": "error",
37+
"valid-typeof": "error",
38+
"array-callback-return": "error",
39+
"no-caller": "error",
40+
"no-extend-native": "error",
41+
"no-extra-bind": "error",
42+
"no-floating-decimal": "error",
43+
"no-global-assign": "error",
44+
"no-iterator": "error",
45+
"no-labels": "error",
46+
"no-lone-blocks": "error",
47+
"no-multi-str": "error",
48+
"no-new-wrappers": "error",
49+
"no-octal": "error",
50+
"no-octal-escape": "error",
51+
"no-proto": "error",
52+
"no-redeclare": "error",
53+
"no-script-url": "error",
54+
"no-self-assign": "error",
55+
"no-sequences": "error",
56+
"no-unused-labels": "error",
57+
"no-useless-call": "error",
58+
"no-useless-concat": "error",
59+
"no-useless-escape": "error",
60+
"no-with": "error",
61+
"radix": "error",
62+
"no-delete-var": "error",
63+
"no-shadow-restricted-names": "error",
64+
"no-undef-init": "error",
65+
"no-new-symbol": "error",
66+
"no-useless-constructor": "error",
67+
"no-useless-rename": "error",
68+
"prefer-numeric-literals": "error",
69+
"prefer-rest-params": "error",
70+
"prefer-spread": "error",
71+
"require-yield": "error",
72+
"symbol-description": "error"
73+
},
74+
"ignorePatterns": [
75+
"node_modules",
76+
".nuxt",
77+
".output",
78+
"dist",
79+
"*.d.ts"
80+
]
81+
}

.storybook/main.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
import type { StorybookConfig } from '@storybook-vue/nuxt'
2+
3+
const config: StorybookConfig = {
4+
stories: ['../app/components/**/*.stories.@(js|jsx|ts|tsx)'],
5+
addons: ['@storybook/addon-a11y', '@storybook/addon-docs'],
6+
framework: '@storybook-vue/nuxt',
7+
staticDirs: ['../public'],
8+
}
9+
10+
export default config

.storybook/preview.ts

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
import type { Preview } from '@storybook-vue/nuxt'
2+
3+
const preview: Preview = {
4+
parameters: {
5+
controls: {
6+
matchers: {
7+
color: /(background|color)$/i,
8+
date: /Date$/i,
9+
},
10+
},
11+
},
12+
};
13+
14+
export default preview;

.vscode/settings.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
{
2-
"cSpell.words": [
3-
"chibivue"
2+
"i18n-ally.localesPaths": [
3+
"i18n",
4+
"i18n/locales"
45
]
56
}

README.md

Lines changed: 50 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,70 @@
1-
# Nuxt Minimal Starter
1+
# chibivue.land
22

3-
Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
3+
chibivue.land is the official website for the chibivue community - a virtual kingdom on the internet where Vue.js enthusiasts gather to learn, build, and share.
44

5-
## Setup
5+
## Tech Stack
66

7-
Make sure to install dependencies:
7+
- **Framework**: [Nuxt 4](https://nuxt.com/)
8+
- **3D Graphics**: [TresJS](https://tresjs.org/)
9+
- **Styling**: [Lightning CSS](https://lightningcss.dev/)
10+
- **Internationalization**: [@nuxtjs/i18n](https://i18n.nuxtjs.org/)
11+
- **Color Mode**: [@nuxtjs/color-mode](https://color-mode.nuxtjs.org/)
12+
- **Package Manager**: [Bun](https://bun.sh/)
13+
- **Deployment**: GitHub Pages
814

9-
```bash
10-
# npm
11-
npm install
12-
13-
# pnpm
14-
pnpm install
15+
## Development
1516

16-
# yarn
17-
yarn install
18-
19-
# bun
17+
```bash
18+
# Install dependencies
2019
bun install
21-
```
22-
23-
## Development Server
2420

25-
Start the development server on `http://localhost:3000`:
26-
27-
```bash
28-
# npm
29-
npm run dev
21+
# Start development server
22+
bun dev
3023

31-
# pnpm
32-
pnpm dev
24+
# Build for production
25+
bun build
3326

34-
# yarn
35-
yarn dev
27+
# Generate static site
28+
bun generate
3629

37-
# bun
38-
bun run dev
30+
# Preview production build
31+
bun preview
3932
```
4033

41-
## Production
34+
## Project Structure
4235

43-
Build the application for production:
44-
45-
```bash
46-
# npm
47-
npm run build
48-
49-
# pnpm
50-
pnpm build
51-
52-
# yarn
53-
yarn build
54-
55-
# bun
56-
bun run build
36+
```
37+
chibivue.land/
38+
├── app/
39+
│ ├── app.vue
40+
│ ├── assets/css/ # Global styles
41+
│ ├── components/ # Vue components
42+
│ │ ├── home/ # Home page sections
43+
│ │ ├── kawaiko/ # Mascot components
44+
│ │ ├── layout/ # Header, Footer, etc.
45+
│ │ ├── tres/ # 3D scene components
46+
│ │ └── ui/ # Reusable UI components
47+
│ ├── composables/ # Vue composables
48+
│ ├── layouts/ # Nuxt layouts
49+
│ └── pages/ # Route pages
50+
├── i18n/locales/ # Translation files (EN/JA)
51+
├── public/ # Static assets
52+
└── .github/workflows/ # CI/CD
5753
```
5854

59-
Locally preview production build:
55+
## Features
6056

61-
```bash
62-
# npm
63-
npm run preview
57+
- Responsive design (mobile-first)
58+
- Dark/Light mode support
59+
- Multi-language support (English/Japanese)
60+
- Interactive 3D scene with TresJS
61+
- Static site generation for GitHub Pages
6462

65-
# pnpm
66-
pnpm preview
63+
## Links
6764

68-
# yarn
69-
yarn preview
65+
- [chibivue Book](https://ubugeeei.github.io/chibivue/)
66+
- [GitHub Organization](https://github.com/chibivue-land)
7067

71-
# bun
72-
bun run preview
73-
```
68+
## License
7469

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

0 commit comments

Comments
 (0)