ZenChat

An online chat web app

An Epitech project by
Darkbuilder646 · Sainseya . Alexis Bizet

Table of Contents

1. About The Project
   • Built With
   • Features
2. Getting Started
   • Prerequisites
   • Installation
3. Utilisation

About The Project

Welcome to ZenChat, an online chat web application aimed at creating a secure and soothing messaging experience. Whether you want to chat privately with friends or engage in group discussions on various topics, ZenChat is here to provide you with a tranquil and user-friendly platform.

(back to top)

Built With

The project was created using the following main languages and frameworks :

For the Front :

For the Back :

API :

(back to top)

Features

• Secure account creation for accessing the application's full functionality.

• Ability to use the application without an account, but with limited features.

• Private messaging by searching for friends via email addresses.

• Creation of chat groups for multiple users to engage in discussions.

• Open-access server with thematic and discussion channels for diverse user interests.

(back to top)

Getting Started

To get ZenChat running on your system, follow these steps :

Prerequisites

Before getting started, ensure you have the following installed :

• NodeJS : Download and install NodeJS from https://nodejs.org/en
• Yarn : Yarn is a package manager for Node.js. You can install by following https://classic.yarnpkg.com/en/docs/install

Installation

1. Clone the Repository :

   git clone https://github.com/EpitechMscProPromo2026/T-JSF-600-LIL_10.git

2. Backend Setup :

   Navigate to the "backend" directory :

   cd backend

   Install dependencies with yarn :

   yarn install

   Start the backend server :

   yarn start

3. Frontend Setup :

   From the root, navigate to the "frontend/zen-chat" directory :

   cd frontend/zen-chat

   Install dependencies with yarn :

   yarn install

   Start the development server :

   yarn run dev

4. Access ZenChat :

   Open your web browser and go to the development server URL to access the ZenChat application

(back to top)

Utilisation

Once the application is running, you can log in with your existing account or create a new account if you haven't already. Explore the different features of ZenChat, including searching for friends by email, creating chat groups, and exploring discussion channels available on the open-access server.

Enjoy your online messaging experience with ZenChat and feel free to provide us with your feedback and suggestions for improving the application.

(back to top)