ayendisimeon1 / dev-project-1

Chattie

Chattie is a real-time chat application that enables users to communicate with each other instantly. Leveraging modern web technologies, Chattie provides a seamless chatting experience with a client-server architecture to handle live messaging, user authentication, and more.

Features

• Real-time Messaging: Instantly send and receive messages.
• User Authentication: Secure user login and registration.
• Private and Group Chats: Create private chats or group conversations.
• Responsive UI: A clean and responsive user interface for an optimal chatting experience across different devices.

Getting Started

To get Chattie up and running on your local development machine, follow the steps below. Ensure you have Node.js (version 18.x or above) and Yarn installed or use the command npm install --global yarn to install yarn.

Installation

1. Fork the repository On the repo page locate and click on the fork button to fork the repository. This create a copy of the repository in your repo list on your github account. Go back to your repository and clone the forked copy of the project repository.

2. Clone the forked copy Repository:

   Begin by cloning Chattie to your local machine using the following command:

   git clone https://github.com/your_username/dev-project-1.git
   cd dev-project-1
   

3. Confirm Node and yarn are installed

Use the command to check and ensure node and yarn are installed
bash node -v yarn -v

4. Install the Dependency:

   yarn install
   

5. Start server:

   yarn start

Front-End Specifics

Note: This is if you want to work on the client side alone:

1. Clone the repository

2. Change directory into dev-project-1 then into client.

cd dev-project-1/client

3. Check and confirm that node and yarn is installed

4. Install the dependencies with yarn install

5. Start the project with yarn dev

   info page is displayed in the browser

   • You can download the icons and images from the figma design link for the project.

Backend Specifics

Note: Some instruction here are to be followed if you want to work on the server side only:

1. Clone the repository

2. Change directory into dev-project-1 then into server.

cd dev-project-1/server

3. Check and confirm that node and yarn is installed

4. Install the dependencies with yarn install

5. Start the project with yarn start

   Hello World is displayed in the browser