Skip to content

Commit

Permalink
docs: readmeを更新
Browse files Browse the repository at this point in the history
  • Loading branch information
Hiratake committed Nov 11, 2023
1 parent f6e94fc commit 5aa6764
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 73 deletions.
7 changes: 5 additions & 2 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,13 @@

### IDE Setup

このプロジェクトでは、 [Visual Studio Code](https://code.visualstudio.com/) の使用を推奨しています。

このプロジェクトでは、 [Visual Studio Code](https://code.visualstudio.com/) の使用を推奨しています。
推奨する拡張機能は `.vscode/extensions.json` に記載しておりますので、適宜インストールするなどの対応をおねがいいたします。

以下のボタンから [StackBlitz Codeflow](https://stackblitz.com/codeflow) を使用して開発や修正をすることも可能です。

[![Open in Codeflow](https://developer.stackblitz.com/img/open_in_codeflow.svg)](https:///pr.new/jaoafa/jaoweb6)

### Package Manager

このプロジェクトでは、パッケージマネージャーに [pnpm](https://pnpm.io/ja/) を採用しています。
Expand Down
85 changes: 14 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,75 +1,18 @@
# Nuxt 3 Minimal Starter
<h1>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/jaoafa/jaoweb6/assets/23224932/dedb7355-e4ba-491c-848e-2300900c2110" sizes="(max-width:280px) 100vw, 280px" />
<source media="(prefers-color-scheme: light)" srcset="https://github.com/jaoafa/jaoweb6/assets/23224932/8e831c14-5247-488e-97b2-e34f2fc10356" sizes="(max-width:280px) 100vw, 280px" />
<img alt="jao Community Server" src="https://github.com/jaoafa/jaoweb6/assets/23224932/8e831c14-5247-488e-97b2-e34f2fc10356" width="280" />
</picture>
</h1>

Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
[![ci](https://github.com/jaoafa/jaoweb6/actions/workflows/ci.yaml/badge.svg)](https://github.com/jaoafa/jaoweb6/actions/workflows/ci.yaml)
[![Open in Codeflow](https://developer.stackblitz.com/img/start_pr_dark_small.svg)](https:///pr.new/jaoafa/jaoweb6)
[![chat](https://img.shields.io/badge/discord-jaoafa-5865F2?logo=discord)](https://discord.gg/jaoafa)

## Setup
jao Community Server のウェブサイトのリポジトリです。
[Nuxt](https://nuxt.com/) を使用して制作しています。

Make sure to install the dependencies:
## 🌟 Contributing

```bash
# npm
npm install

# pnpm
pnpm install

# yarn
yarn install

# bun
bun install
```

## Development Server

Start the development server on `http://localhost:3000`:

```bash
# npm
npm run dev

# pnpm
pnpm run dev

# yarn
yarn dev

# bun
bun run dev
```

## Production

Build the application for production:

```bash
# npm
npm run build

# pnpm
pnpm run build

# yarn
yarn build

# bun
bun run build
```

Locally preview production build:

```bash
# npm
npm run preview

# pnpm
pnpm run preview

# yarn
yarn preview

# bun
bun run preview
```

Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
プロジェクトへの貢献をご検討の方は、 [CONTRIBUTING.md](.github/CONTRIBUTING.md) をご確認ください。

0 comments on commit 5aa6764

Please sign in to comment.