Skip to content
This repository has been archived by the owner on Sep 17, 2024. It is now read-only.

Commit

Permalink
chore: Update documentation URLs and ports
Browse files Browse the repository at this point in the history
  • Loading branch information
nonoakij committed May 22, 2024
1 parent 930f519 commit 34feb60
Show file tree
Hide file tree
Showing 3 changed files with 107 additions and 4 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ pnpm run dev

- 今回のHands-onで作業するサイトのURLです [http:localhost:3000](http:localhost:3000)
- 今回のHands-onの目標のサイトのURLです [http:localhost:4000](http:localhost:4000)
- Hands-onの進め方が書いています[http:localhost:5000](http:localhost:5000)
- Hands-onの進め方が書いています[http:localhost:5050](http:localhost:5050)
- Backend Server のURLです[http:localhost:8000](http:localhost:8000)

## これで準備は完了です
Expand All @@ -93,8 +93,12 @@ Hands-onを進めていきましょう!

script | description
--- | ---
`pnpm run dev` | 開発サーバーを起動します
`pnpm run dev:workspace` | 開発サーバーを起動します
`pnpm run dev` | すべてを起動します
`pnpm run dev:workspace` | workspaceのみを起動します
`pnpm run dev:solution` | solutionのみを起動します
`pnpm run dev:docs` | docsのみを起動します
`pnpm run dev:backend` | backendのみを起動します
`pnpm run hands-on` | workspace と backend を起動します
`pnpm run build` | ビルドします
`pnpm run start` | ビルドしたアプリケーションを起動します
`pnpm run lint` | lint を実行します
Expand Down
2 changes: 1 addition & 1 deletion docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"check": "biome check -apply ./*"
},
"config": {
"port": 5000
"port": 5050
},
"dependencies": {
"@astrojs/check": "0.7.0",
Expand Down
99 changes: 99 additions & 0 deletions docs/src/content/docs/guides/2-getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,105 @@
title: 2. はじめる
description: 2. はじめる
---
import { Tabs, TabItem } from '@astrojs/starlight/components';
import { Aside } from '@astrojs/starlight/components';

## インストール


### リポジトリをクローンする

以下のいずれかの方法でリポジトリをクローンしてください。

<Tabs syncKey="constellations">
<TabItem label="https">
``` bash
git clone https://github.com/nonoakij/next-js-hands-on.git
```
</TabItem>
<TabItem label="ssh">
``` bash
git clone [email protected]:nonoakij/next-js-hands-on.git
```
</TabItem>
<TabItem label="gh">
``` bash
gh repo clone nonoakij/next-js-hands-on
```
</TabItem>
</Tabs>

### プロジェクトディレクトリに移動する

``` bash
cd next-js-hands-on
```

### 依存関係をインストールする

``` bash
pnpm install
```

<Aside type="tip">
`pnpm` をインストールしていない場合は、以下のコマンドでインストールしてください。

<Tabs syncKey="constellations">
<TabItem label="brew">
``` bash
brew install pnpm
```
</TabItem>
<TabItem label="npm">
``` bash
npm install -g pnpm
```
</TabItem>
<TabItem label="Corepack">
``` bash
corepack enable pnpm
```
Homebrew を使用して Node.js をインストールした場合は、Corepack を個別にインストールする必要があります。

``` bash
brew install corepack
```
</TabItem>
</Tabs>

その他のインストール方法は、[pnpm 公式サイト](https://pnpm.io/ja/installation)を参照してください。
</Aside>

### 開発サーバーを起動する

``` bash
pnpm run dev
```

### ブラウザで以下の URL にアクセスできることを確認してください

- workspace `http:localhost:3000`
- solution `http:localhost:4000`
- docs `http:localhost:5050/next-js-hands-on`
- backend `http:localhost:8000`

## これで準備は完了です

Hands-onを進めていきましょう!

## scripts

script | description
--- | ---
`pnpm run dev` | すべてを起動します
`pnpm run dev:workspace` | workspaceのみを起動します
`pnpm run dev:solution` | solutionのみを起動します
`pnpm run dev:docs` | docsのみを起動します
`pnpm run dev:backend` | backendのみを起動します
`pnpm run hands-on` | workspace と backend を起動します
`pnpm run build` | ビルドします
`pnpm run start` | ビルドしたアプリケーションを起動します
`pnpm run lint` | lint を実行します
`pnpm run format` | format を実行します
`pnpm run check` | lint と format を実行します
`pnpm run type-check` | 型チェックを実行します

0 comments on commit 34feb60

Please sign in to comment.