Local-Chat-Messenger

🌱概要

クライアントサーバ間で情報のやりとりができるシンプルなアプリケーション

✨デモ

📝説明

このアプリケーションは、クライアントサーバ間で情報のやりとりができるシンプルなアプリケーションです。

アプリケーションの実行には、ターミナルという黒い画面にコマンドを入力します。

このアプリケーションでは、メッセージの送信と受信というシンプルな情報のやりとりを体験することができます。

ユーザーがメッセージを送信すると、サーバは、そのメッセージを受け取り、何らかのメッセージを返してくれます。

サーバから返されるメッセージは、フェイクデータなので送信したメッセージの正確な返答ではありません。

例. 送信:Hello! / 受信:Apple

基本的な機能として、メッセージの送信と受信/ステータスの表示ができます。

補足

説明で登場する用語について補足します。

用語の意味がわからない時は、下記表を確認してください。

用語	意味
クライアント	サーバに接続し、データの取得や処理の依頼などを行うプログラムやコンピュータシステムのことです。
サーバ	ネットワークを介してクライアントの要求に応答し、データ、サービス、リソースを提供するシステムやソフトウェアのことです。
ターミナル	コンピュータに対してテキストベースのコマンド入力と出力を行うインターフェースのことです。 このインターフェースは、コマンドラインインターフェース（CLI）とも呼ばれます。 デモで表示されている黒い画面のことです。
コマンド	コンピュータに対して特定の操作を実行するよう指示するテキストベースの命令です。 コマンドを入力することで、コンピュータは、コマンドの意味を読み取りアクションをおこします。

🧰前提条件

このアプリケーションを実行するには、下記ソフトウェアを事前にインストールしておく必要があります。

インストールされていない場合は、インストール/使用方法/使用例で記載されているコマンドが実行できませんので

必ずインストールしてから進めてください。

Git

Gitがインストールされていない場合は、下記手順でインストールしてください。

1. ターミナルを起動する。
   使用するOSによりターミナルの名称が異なりますので注意してください。
   (例. Windows:コマンドプロンプト,mac:ターミナル)

2. Gitがインストールされているか確認する。
   git version 2.34.1 のように表示された場合は、Gitがインストールされています。
   以降の手順はスキップしてください。
   また、ターミナルは引き続き使用しますので開いたままにしてください!

git --version

3. システムを更新する

sudo apt-get update

4. Gitをインストールする

sudo apt install git

5. Gitがインストールされたことを確認する。
   git version 2.34.1 のように表示されていれば、Gitのインストールは完了です!

git --version

Python 3.x

Pythonの公式サイトからあなたのPCのOSに合わせて、ダウンロードしてください。

ダウンロードしたファイルを使用してインストールできます。

Pythonがインストールされているかは、下記コマンドで確認することができます。

Python 3.10.12のように表示されていれば、Pythonはインストールされています。

python3 --version

pip

pipは、Python用のパッケージマネージャで、パッケージのインストールと管理を行うことができます。

pipのインストールガイドに従って、pipをインストールしてください。

aptを使用してpipをインストールする場合は、下記手順でインストールしてください。

1. pipがインストールされているか確認する。
   pip 22.0.2 from /usr/lib/python3/dist-packages/pip (python 3.10) のように表示された場合は、pipがインストールされています。
   以降の手順はスキップしてください。

pip3 --version

2. システムを更新する

sudo apt-get update

3. pipをインストールする

sudo apt install python3-pip

4. pipがインストールされたことを確認する。
   pip 22.0.2 from /usr/lib/python3/dist-packages/pip (python 3.10) のように表示されていれば、pipのインストールは完了です!

pip3 --version

Faker

Fakerは、様々な種類の偽データを生成することができるPythonのパッケージです。

pipを使用して、下記手順でインストールしてください。

pipは、あらかじめインストールしておいてください。

また、Fakerについて詳しく知りたい場合は、Fakerのプロジェクトの説明を確認してください。

1. Fakerがインストールされているか確認する。
   Name/Version/Summaryなどが表示された場合は、Fakerがインストールされています。
   以降の手順はスキップしてください。

pip3 show Faker

2. Fakerをインストールする

pip3 install Faker

3. Fakerがインストールされたことを確認する。
   Name/Version/Summaryなどが表示されていれば、Fakerのインストールは完了です!

pip3 show Faker

🍴インストール

クローン

このアプリケーションをあなたのPCで実行するために、クローンします。

クローンとは、このアプリケーションの実行に必要なファイル(リポジトリのコンテンツ)をあなたのPCのローカル環境へコピーすることです。

下記手順でクローンしてください。

1. リポジトリをクローンする

git clone https://github.com/Aki158/Local-Chat-Messenger.git

2. クローンしたリポジトリへ移動する

cd Local-Chat-Messenger

🚀使用方法

1. 1つ目のターミナル(サーバ用ターミナルとする)を起動する
2. サーバ用ターミナルに下記コマンドを入力する

python3 server.py

3. 2つ目のターミナル(クライアント用ターミナルとする)を起動する
4. クライアント用ターミナルに下記コマンドを入力する

python3 client.py

5. クライアント用ターミナルにメッセージを入力し送信する
6. クライアントが送信したメッセージが、サーバ用ターミナルに表示される
7. サーバ用ターミナルが何らかのメッセージを送信し、クライアント用ターミナルにメッセージが表示される

🙋使用例

一通りの手順のイメージはデモを参考にしてください。

1. 1つ目のターミナル(サーバ用ターミナルとする)を起動する
2. サーバ用ターミナルに下記コマンドを入力する

python3 server.py

3. 2つ目のターミナル(クライアント用ターミナルとする)を起動する
4. クライアント用ターミナルに下記コマンドを入力する

python3 client.py

5. クライアント用ターミナルにメッセージを入力し送信する。
   今回は、Hello!と入力する。
6. クライアントが送信したメッセージが、サーバ用ターミナルに表示される。
   Hello!がサーバ用ターミナルに表示された。
7. サーバ用ターミナルが何らかのメッセージを送信し、クライアント用ターミナルにメッセージが表示される。
   何らかのメッセージがクライアント用ターミナルに表示された。

💾使用技術

カテゴリ	技術スタック
開発言語	Python
インフラ	Ubuntu
	VirtualBox
その他	Git
	Github

👀機能一覧

機能	内容
メッセージの表示	送受信されたメッセージやステータスを表示します。
クライアント	ユーザーから入力を受け取り、その入力をサーバに送信します。 また、サーバからのメッセージを受信します。
サーバ	クライアントからのメッセージを受け取り、それに対する応答を何らかのメッセージを生成し送り返します。

📮今後の実装したいもの

• メッセージを複数回送受信できるようにする

📑参考文献

公式ドキュメント

• Python

参考にしたサイト

• Python_Download
• pipのインストールガイド
• Fakerのプロジェクトの説明