https://github.com/kazuma1989/firebook
https://github.com/kazuma1989/firebook
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kazuma1989/firebook
- Owner: kazuma1989
- Created: 2021-04-01T22:22:05.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2021-05-18T19:08:31.000Z (about 4 years ago)
- Last Synced: 2025-01-22T09:33:07.598Z (4 months ago)
- Language: TypeScript
- Homepage:
- Size: 580 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Firebook
```console
npx hina kazuma1989/firebook
```
## これは何
Firebook という架空の SNS サイトを実装しながら学習するためのスターターテンプレートです。
次のパッケージをあらかじめセットアップしてあります。
- Emotion
- React
- ESLint
- Prettier
- TypeScript
- Vite
IDE は Visual Studio Code が推奨です。必要な拡張機能をすぐインストールできるようにしてあります。
## 利用可能なスクリプト
### `npm start [-- --no-open]`
アプリを開発モードで起動します。ブラウザーが起動して http://localhost:3000 が表示されます。
ブラウザーを起動したくないときは `-- --no-open` オプションを渡してください。
もしくは環境変数 `BROWSER` を `none` に設定してください。(e.g. `BROWSER=none npm start`)
ソースコードを編集するとページがリロードします。
TypeScript による型検査のエラーはコンソールに表示されます。
### `npm run build`
アプリを静的資材として `build/` ディレクトリにコピーします。
そのディレクトリをデプロイすれば OK です！
### `npm run format`
ソースコードを整形します。
### `npm run lint`
ソースコードを静的検査します。