Talckatoo

Talckatoo is a real-time chat application created using Vite, TypeScript, and Socket.IO. It features a backend that manages all the responses and facilitates seamless communication between users. This README file provides essential information to get started with the application, including installation instructions and usage guidelines.

Link Demo: https://youtu.be/lkLmidpuwNU

Table of Contents

• Talckatoo Chat App
• Table of Contents
• Features
• Prerequisites
• Installation
• Usage
• Technologies Used
• Backend
• Contributing
• License
• Thanks

Features

Talckatoo offers the following features:

• Real-time messaging between users.
• User authentication and authorization.
• Display of active users in each chat room.
• Typing indicators for live chat feedback.

Prerequisites

Before proceeding with the installation, make sure you have the following tools installed on your machine:

• Node.js (v14 or later)
• npm (Node Package Manager)
• Git (optional)

Installation

1. Clone the repository to your local machine using Git or download and extract the ZIP file.

git clone git@github.com:Talckatoo/talckatoo_client.git

2. Navigate to the project directory.

cd talckatoo-client

3. Install the project dependencies using npm.

npm install

Usage

1. Start the development server.

npm run start

2. Open your browser and navigate to http://localhost:3000 to access the Talckatoo chat app.

3. Create an account or log in to an existing account to start using the chat app.

Technologies Used

Talckatoo is built with the following technologies:

• Vite: Fast and lightweight frontend build tooling.
• TypeScript: A typed superset of JavaScript that adds static types to the language.
• Socket.IO: Enables real-time, bidirectional, and event-based communication between the browser and the server.

The backend is built using the technology of your choice (e.g., Node.js with Express, Python with Django, etc.). Make sure to include relevant documentation for the backend in a separate file.

👥 Author

• 👤 Rabiu Abdulazeez Danmaihaja Abdulaiman
• 👤 Manny Montes mdmontes
• 👤 Tam Pham Miminiverse
• 👤 Laasri Said Said Laasri

Backend

Talckatoo relies on a powerful backend system that handles real-time messaging and manages responses. The backend is built using Node.js with Express. For more details on setting up and configuring the backend, please refer to the documentation provided separately. LINK: https://github.com/Talckatoo/talckatoo_server

Contributing

We welcome contributions to Talckatoo! If you find any issues or want to suggest enhancements, open an issue or submit a pull request. Make sure to follow the guidelines mentioned in the CONTRIBUTING.md file.

License

The Talckatoo Chat App is open-source software licensed under the LICENSE.

Thanks

Thank you for choosing Talckatoo! We appreciate your support and hope you find our chat app useful for your real-time communication needs. If you have any questions or need any more help, please don't hesitate to contact us. Happy chatting! 🐦💬

Special thanks to :

* Frank Stepanski ****

* Roy Mosby ****

* Jaheem Prevost ***