Skip to content

Latest commit

 

History

History
123 lines (89 loc) · 5.4 KB

README.md

File metadata and controls

123 lines (89 loc) · 5.4 KB

Website

私たちについてや活動内容、イベント告知、入会申請をまとめたサークルのウェブサイトです🧸

Tech Stack

Environments Languages Linters Frameworks Libraries Testing CI/CD PaaS
node-logo
npm-logo
ts-logo
sass-logo
eslint-logo
stylelint-logo
prettier-logo
lefthook-logo
next-logo react-logo
tailwind-logo
swr-logo
zod-logo
rhf-logo
vitest-logo
storybook-logo
githubactions-logo vercel-logo
cloudflarepages-logo
cloudflare-logo

ほか

Architecture

イベント告知やそのほかの資料について、データベースの使用はオーバーエンジニアリング気味なため、このレポジトリのフォルダにmarkdownファイルを作り、それをHTMLにパースする構成となる。

architecture markdown

入会申請の通知はDiscord Webhookを利用する。

architecture newcomer

Development

  1. 必須
  2. 環境変数
  3. コマンド

必須

node = ">=20.18"
npm = ">=10.9"

Tip

詳細は.prototoolsを参照する。

環境変数

NEXT_PUBLIC_HOST_ORIGIN_URL="http://localhost:3000"
MARKDOWN_DIR_PATH="markdowns"
DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/{your-webhook-id}/{your-webhook-token}"

Tip

詳細は.env.exampleを参照する。

コマンド

パッケージのインストール

npm i

Important

初回インストールの後(保存時のフォーマットが動作しない場合)は、VS Code (IDE)を再起動する。

Note

将来的にLinterとFormatterは、ESLintとPrettierの構成からBiomeに移行したい。ただし、設定項目を照らし合わせて互換性をチェックする必要がある。

開発サーバの起動

npm run dev

リンターのチェック

npm run lint

コードのフォーマット

npm run format

UIコンポーネントのテスト

npm run sb

その他のテスト

npm run test