Skip to content

Commit

Permalink
Edit readme layout
Browse files Browse the repository at this point in the history
  • Loading branch information
lovephimu committed Jan 28, 2024
1 parent 4d88885 commit 987208e
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,29 @@ An open chat-room where everyone with an IP and a browser can post!

### UI

<img src="https://github.com/lovephimu/next-chat-app/blob/main/public/ui_mobile.png" alt="Chat Logo" width="200" height="auto">
<img src="https://github.com/lovephimu/next-chat-app/blob/main/public/ui_screen.png" alt="Chat Logo" width="200" height="auto">
<figure>
<img src="https://github.com/lovephimu/next-chat-app/blob/main/public/ui_feedback1.png" alt="Chat Logo 1" width="200" height="auto">
<figcaption>Mobile layout</figcaption>
</figure>

<figure>
<img src="https://github.com/lovephimu/next-chat-app/blob/main/public/ui_feedback2.png" alt="Chat Logo 2" width="200" height="auto">
<figcaption>Screen layout (has an additional statistic button)</figcaption>
</figure>

- The chat interface has a simplistic design in the spirit of old open chat rooms.
- While there is mainly the chat interface the possibility of navigating to other pages becomes available on bigger screens - keeping the mobile interface simple and making options available when there is space
- Responsive design: Screen resolution covered: Mobile to 1080p

<figure>
<img src="https://github.com/lovephimu/next-chat-app/blob/main/public/ui_feedback1.png" alt="Chat Logo" width="200" height="auto">
<figcaption>First notification</figcaption>
</figure>

<figure>
<img src="https://github.com/lovephimu/next-chat-app/blob/main/public/ui_feedback2.png" alt="Chat Logo" width="200" height="auto">
<figcaption>Second notification</figcaption>
</figure>

- Visual feedback: the messaging system is designed to allow only short messages. To keep the user informed there is a character count and additional alerts when the character limit is reached or exceeded
- Although most of the app is styed using Tailwind I do use CSS in special cases like the animated statistics button and the D3 chart
Expand All @@ -50,6 +64,12 @@ An open chat-room where everyone with an IP and a browser can post!
- Character limit & maximum stored messages are controlled by the global variables "globalCharacterLimit" and "globalMessageLimit". By default they are set to 280 and 5.
- Character limit is checked client and server side to ensure the correct format at all times
- Links are being rendered as clickable links using a regex.

<figure>
<img src="https://github.com/lovephimu/next-chat-app/blob/main/public/d3_feature.png" alt="Chat Logo" width="200" height="auto">
<figcaption>Simple D3 chart tracking browser usage</figcaption>
</figure>

- A d3 chart visualizes the most used browser among the stored chat messages [D3 Statistic](https://chat-schibidi.vercel.app/visitors)

### Todos
Expand Down
Binary file added public/d3_feature.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 987208e

Please sign in to comment.