Skip to content

Commit d5e9d58

Browse files
chore: update readme with screenshots
1 parent 75dc8b6 commit d5e9d58

File tree

7 files changed

+51
-26
lines changed

7 files changed

+51
-26
lines changed

.dockerignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
.vscode
33
deploy
44
vendor.protogen
5+
assets
56
bin
67
/bin/
78
docker-compose.yaml

README.md

Lines changed: 50 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,20 @@ make install-deps
6060

6161
## Command Usage 🚀
6262

63-
### Auth Service Commands
63+
### CLI Commands Overview (branch feat/cli - deprecated)
64+
65+
Our CLI client now supports various commands to interact with the backend services seamlessly using Cobra and Bubbletea. Here are a few:
66+
67+
- **Auth Service Commands**
68+
- `gchat register`: Register a new user.
69+
- `gchat login`: Login with existing credentials.
70+
- `gchat list-user`: List all users.
71+
- **Chat Service Commands**
72+
- `gchat create-chat`: Create a chat with the specified users.
73+
- `gchat list-chat`: List all user chats.
74+
- `gchat connect-chat`: Connect to a specific chat by chat ID.
75+
76+
Example commands:
6477

6578
- **Register a New User**
6679

@@ -80,8 +93,6 @@ go run main.go login --login "[email protected]" --password "password"
8093
go run main.go list-user
8194
```
8295

83-
### Chat Service Commands
84-
8596
- **Create a Chat**
8697

8798
```bash
@@ -100,15 +111,41 @@ go run main.go list-chat
100111
go run main.go connect-chat --chat-id "chat123"
101112
```
102113

103-
### CLI Commands Overview
114+
## New Interaction Through Bubbletea
115+
116+
The interaction with our application is now fully integrated with Bubbletea, providing a rich, interactive terminal user interface (TUI). This change enhances user experience and allows for more dynamic and responsive interactions.
117+
118+
### Screenshots
119+
120+
- **Login**
121+
122+
![Login Screen](/assets/screenshots/login.png)
123+
124+
The login allows users to enter their credentials and access the chat service.
125+
126+
- **Registration**
127+
128+
![Registration Screen](/assets/screenshots/registration.png)
129+
130+
The registration enables users to create a new account by providing their name, email, and password.
104131

105-
Our CLI client supports various commands to interact with the backend services seamlessly. Here are a few:
132+
- **Create Chat**
106133

107-
- `register`: Register a new user.
108-
- `login`: Login with existing credentials.
109-
- `create-chat`: Create a chat with the specified users.
110-
- `list-chat`: List of all user chats.
111-
- `connect-chat`: Connect to a specific chat by chat ID.
134+
![Create Chat Screen](/assets/screenshots/create_chat.gif)
135+
136+
The create chat allows users to initiate a new chat room by selecting participants and starting conversations.
137+
138+
- **Chat List Screen**
139+
140+
![Chat Room](/assets/screenshots/chat_list.png)
141+
142+
The chat list shows a list of chat rooms the user is part of and allows seamless navigation between them.
143+
144+
- **Chat Interaction**
145+
146+
![Chat Interaction Screen](/assets/screenshots/chat.gif)
147+
148+
The chat interaction provides a real-time chat interface where users can send and receive messages.
112149

113150
## Architecture Overview 🏗️
114151

@@ -117,7 +154,7 @@ Our project is organized as a monorepository containing three main applications:
117154
### Auth Service
118155

119156
- **Database**: PostgreSQL
120-
- **Functionality**: manages user registration, login, and authentication using access and refresh tokens.
157+
- **Functionality**: manages user registration, login, and authentication using access and refresh tokens
121158

122159
### Chat Service
123160

@@ -126,8 +163,8 @@ Our project is organized as a monorepository containing three main applications:
126163

127164
### CLI Client
128165

129-
- **Framework**: Cobra
130-
- **Functionality**: a command-line interface that allows users to interact with the Auth and Chat services.
166+
- **Framework**: Cobra and Bubbletea
167+
- **Functionality**: a command-line interface that allows users to interact with the Auth and Chat services using a rich TUI
131168

132169
#### Key Features
133170

@@ -213,19 +250,6 @@ Ensure that the following environment variables are set in your GitHub repositor
213250
- `VPS_USER`: Your VPS user.
214251
- `VPS_HOST`: Your VPS host address.
215252

216-
## Future Plans 🌅
217-
218-
My plan to rewrite the CLI application from Cobra to Bubble Tea to build a full-fledged console UI. This will provide a more interactive and user-friendly experience for users interacting with my services via the command line.
219-
220-
### Why Bubble Tea?
221-
222-
- **Rich Interactive UI**: Bubble Tea allows us to build rich, interactive UIs directly in the terminal, enhancing user experience.
223-
- **Customization**: Offers a high degree of customization, enabling us to tailor the interface to my specific needs.
224-
- **Active Community**: Supported by an active community and regularly updated. [Bubble Tea GitHub Repository](https://github.com/charmbracelet/bubbletea)
225-
- **Ease of Use**: Simplifies the development of complex terminal applications, making the process more intuitive and efficient.
226-
227-
With these enhancements, I aim to provide a powerful and engaging CLI tool that leverages the capabilities of Bubble Tea to its fullest potential.
228-
229253
## Acknowledgments 🙌
230254

231255
I hope you enjoy using the CLI Chat as much as we enjoyed building it. If you find it useful, give us a ⭐ on GitHub!

assets/screenshots/chat.gif

150 KB
Loading

assets/screenshots/chat_list.png

76.2 KB
Loading

assets/screenshots/create_chat.gif

899 KB
Loading

assets/screenshots/login.png

47.2 KB
Loading

assets/screenshots/registration.png

49.7 KB
Loading

0 commit comments

Comments
 (0)