You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
64
77
65
78
-**Register a New User**
66
79
@@ -80,8 +93,6 @@ go run main.go login --login "[email protected]" --password "password"
80
93
go run main.go list-user
81
94
```
82
95
83
-
### Chat Service Commands
84
-
85
96
-**Create a Chat**
86
97
87
98
```bash
@@ -100,15 +111,41 @@ go run main.go list-chat
100
111
go run main.go connect-chat --chat-id "chat123"
101
112
```
102
113
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
+

123
+
124
+
The login allows users to enter their credentials and access the chat service.
The chat interaction provides a real-time chat interface where users can send and receive messages.
112
149
113
150
## Architecture Overview 🏗️
114
151
@@ -117,7 +154,7 @@ Our project is organized as a monorepository containing three main applications:
117
154
### Auth Service
118
155
119
156
-**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
121
158
122
159
### Chat Service
123
160
@@ -126,8 +163,8 @@ Our project is organized as a monorepository containing three main applications:
126
163
127
164
### CLI Client
128
165
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
131
168
132
169
#### Key Features
133
170
@@ -213,19 +250,6 @@ Ensure that the following environment variables are set in your GitHub repositor
213
250
-`VPS_USER`: Your VPS user.
214
251
-`VPS_HOST`: Your VPS host address.
215
252
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
-
229
253
## Acknowledgments 🙌
230
254
231
255
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!
0 commit comments