Skip to content

Commit

Permalink
docs: improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SegaraRai committed Oct 28, 2023
1 parent 0165cb1 commit 5f04f93
Showing 1 changed file with 34 additions and 48 deletions.
82 changes: 34 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,75 +1,61 @@
# Nuxt 3 Minimal Starter
# Luonto

Look at the [Nuxt 3 documentation](https://nuxt.com/docs/getting-started/introduction) to learn more.
[Luonto](https://luonto.null.lu/)[Nature Remo](https://nature.global/) の非公式 Web アプリケーションです

## Setup
Nuxt 3 で作成しており、Service Worker 上で SSR を行います
PWA にも対応しているので、オフラインでも動作します (キャッシュされた情報が見れるだけですが…)

Make sure to install the dependencies:
使用にあたっては予め Nature の API アクセストークンを取得しておく必要があります
[こちら](https://home.nature.global/) から取得してください

```bash
# npm
npm install
API への送信処理はすべてローカルで行われるため、アクセストークンが Nature の API サーバー以外に送信されることはありません
Luonto をホストしているサーバー (Cloudflare Pages) は静的アセットの配信にのみ使用しています
万が一アクセストークンが漏洩した場合は、Nature の API サーバーからアクセストークンを無効化してください

# pnpm
pnpm install
## 開発方法

# yarn
yarn install
以下が必要です

# bun
bun install
```
- [Node.js](https://nodejs.org/) v20
- [pnpm](https://pnpm.io/) v8

## Development Server
[Bun](https://bun.sh/) が正式に Windows に対応したら pnpm から移行するかも

Start the development server on `http://localhost:3000`:
### セットアップ

```bash
# npm
npm run dev

# pnpm
pnpm run dev
pnpm install
```

# yarn
yarn dev
### 開発サーバーの起動

# bun
bun run dev
```bash
pnpm run dev
```

## Production
`http://localhost:3000` で確認できます

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:
`.output/public` に静的アセットが出力されます

```bash
# npm
npm run preview
### プロダクションビルドのプレビュー

# pnpm
```bash
pnpm run preview
```

# yarn
yarn preview
`http://localhost:3000` でプレビューできます

# bun
bun run preview
```
### デプロイ

`.output/public` を配信すれば OK です (JavaScript の動作するサーバーは必要ありません)
Cloudflare Pages にデプロイする場合は以下のコマンドを実行してください

Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
```bash
pnpm wrangler pages deploy .output/public
```

0 comments on commit 5f04f93

Please sign in to comment.