はじめに
READMEのテンプレがあったら便利だと思ったため投稿。
これから業務や自学での経験によってよりいい描き方が出てくるかもしれないがその時は随時更新。
READMEの重要性
こちらが参考になりました。
デザイン凝るくらいならREADME丁寧に書く方が重要らしい。
これから実務に関わるので先輩エンジニアのREADMEをぜひ拝見したい...。
以下テンプレ
# Name（リポジトリ/プロジェクト/OSS などの名前）
チャットアプリ(React.ts)
# DEMO
[デモ](https://chatapp-reactts.web.app/)
アプリの使い方が直感で分かる画像を載せる
# Features
アプリの差別化等特徴を載せる
## ログイン
- Google ログインか mail・password によるログインで利用可能
(テストユーザーとしては、mail: usera@gmail.com,
password: test00 でログイン・利用可能)
## メッセージ
- 画像を添付したメッセージの送信が可能(画像なしでも可)
## レスポンス
メッセージ下の吹き出しアイコンをクリックすると、
メッセージに返信することが可能
## ログアウト
- メッセージ入力欄横のアイコンをクリックすることでログアウトが可能
と、こんな感じで機能ごとに解説する？
# Requirement
アプリを動かすのに必要なライブラリ等を挙げる
- @material-ui/core: ^4.11.3
- @material-ui/icons: ^4.11.2
- @reduxjs/toolkit: ^1.5.1
- firebase: ^8.4.1
- react: ^17.0.2,
- react-redux : ^7.2.0
- typescript: ~4.1.5
# Installation
Requirementのインストール方法を書く
npx create-react-app . --template redux-typescript
yarn add @material-ui/core @material-ui/icons
yarn add firebase
# Usage
デモの実行方法を書く
```bash
git clone https://github.com/UserName/AppName.git
cd AppName
yarn start
# Author
作成情報を列挙する
- 作成者: Haruna Ezure
- 所属:
- E-mail: burimofumofu@gmail.com
# License
作成情報を書く。ライセンスの取り方については[こちら](https://qiita.com/shibukk/items/67ad0a5eda5a94e5c032)を参考にする。MITが推奨。
[MIT license](https://en.wikipedia.org/wiki/MIT_License).