Skip to content

Commit

Permalink
Update README.md for improved clarity and formatting; adjust package-…
Browse files Browse the repository at this point in the history
…lock.json for consistent versioning
  • Loading branch information
H1B0B0 committed Dec 10, 2024
1 parent 5bfe32e commit 70ac4fa
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 32 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,25 @@
# Kurama-Chat

## Overview :

![Example](./pictures/kurama-chat.png)

This project involves the development of an Internet Relay Chat (IRC) client and server using NodeJS + ExpressJS for the server and ReactJS for the client. The system is designed to handle multiple simultaneous connections, allowing users to join, create, rename, and delete channels. Additionally, it supports real-time messaging within channels, including notifications when users join or leave a channel.

## Features :

- **1.** Multiple Channel Support: Users can join several channels simultaneously.
- **2.** Channel Management: Ability to create, rename, and delete channels.
- **3.** Real-time Notifications: Notifications for user join/leave events.
- **4.** Messaging: Users can speak in channels they've joined, send private messages, and list users in channels.
Persistence
Persistence
- **5.** Channels and messages are persistently stored using a chosen method (file, database, etc.).
- **6.** User Interaction
- **7.** Users must set a nickname to use the application. No authentication system is required, but adding one is a bonus.
- **8.** The client and server communicate using a chosen protocol.

## Commands :

- /nick: Set user nickname.
- /list: List available channels, with optional search.
- /create: Create a new channel.
Expand All @@ -27,8 +32,8 @@ Persistence

This README outlines the core functionalities and commands supported by the IRC client and server project.

# Installation :
# Installation :

Open a terminal at the root of the project and use :
Open a terminal at the root of the project and use :

```docker compose up -d```
`docker compose up -d`
48 changes: 20 additions & 28 deletions frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file added pictures/kurama-chat.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 70ac4fa

Please sign in to comment.