Skip to content

Commit 14028ab

Browse files
authored
Docs/append readme (#35)
* docs: READMEを更新 * feat: VSCodeの推奨拡張機能を追加
1 parent 430a4e5 commit 14028ab

File tree

4 files changed

+37
-4
lines changed

4 files changed

+37
-4
lines changed

Diff for: .cspell.json

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
"prisma",
1616
"prismock",
1717
"Segoe",
18+
"shadcn",
1819
"sqlite",
1920
"Uncapitalize",
2021
"uuid"

Diff for: .dev.vars.example

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
AUTH0_DOMAIN=
2+
AUTH0_CLIENT_ID=
3+
AUTH0_CLIENT_SECRET=
4+
AUTH0_CALLBACK_URL=http://localhost:5173/auth/callback
5+
CF_PAGES_URL=http://localhost:5173
6+
SESSION_SECRET=

Diff for: .vscode/extensions.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
{
22
"recommendations": [
3-
"dbaeumer.vscode-eslint"
3+
"dbaeumer.vscode-eslint",
4+
"bradlc.vscode-tailwindcss",
5+
"streetsidesoftware.code-spell-checker",
6+
"prisma.prisma"
47
]
58
}

Diff for: README.md

+26-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,34 @@
1-
# Remix Vite Template
1+
# 名簿システムv3
22

3-
## Tech Stack
3+
## 使用技術
44
- React@19
55
- Remix
66
- Vite
7-
- Restyle
7+
- shadcn/ui
8+
- Tailwind CSS
89
- Radix UI (Primitives)
910
- TypeScript
1011
- ESLint@9
1112
- Cloudflare Pages
13+
14+
## セットアップ
15+
### 1. リポジトリをクローン
16+
https://github.com/SystemEngineeringTeam/meibo-system-v3 をクローン
17+
18+
### 2. パッケージをインストール
19+
```bash
20+
pnpm install
21+
```
22+
23+
### 3. 環境変数を設定
24+
`.dev.vars.example` をコピーして `.dev.vars` を作成し、環境変数を設定
25+
```bash
26+
cp .dev.vars.example .dev.vars
27+
```
28+
29+
中身は slack のピン留めを参照
30+
31+
### 4. 開発サーバーを起動
32+
```bash
33+
pnpm dev
34+
```

0 commit comments

Comments
 (0)