Chat App using Next.js 13, Tailwind CSS, Prisma, MongoDB, and TypeScript

Welcome to the documentation for our modern and feature-rich chat application built with cutting-edge technologies including Next.js 13, Tailwind CSS, Prisma, MongoDB, and TypeScript.

Table of Contents

• Introduction
• Features
• Technologies Used
• Getting Started
  • Prerequisites
  • Installation
  • Configuration
• Usage
• Contributing
• License

Introduction

Our chat application is designed to provide users with a seamless and interactive chatting experience. Whether you're looking to connect with friends, family, or colleagues, our app offers a user-friendly interface and powerful features that make communication enjoyable and efficient.

Features

• Real-time messaging: Engage in real-time conversations with instant message updates.
• User authentication: Securely register and log in to access the chat functionality.
• User profiles: Customize your profile, set a display picture, and update your status.
• Group chats: Create and participate in group conversations with multiple participants.

Technologies Used

• Next.js 13: A cutting-edge React framework that enables server-side rendering, routing, and more.
• Tailwind CSS: A highly customizable CSS framework that speeds up UI development.
• Prisma: A modern database toolkit that simplifies database access with type-safe queries.
• MongoDB: A NoSQL database for scalable and flexible data storage.
• TypeScript: A statically-typed superset of JavaScript that enhances code quality and maintainability.

Running on the web

• Navigate to: Chatly

Localy running the project

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js: Download

Installation

1. Clone the repository:

   git clone https://github.com/Korabi123/Chatly.git

2. Navigate to the project directory:

   cd Chatly

3. Install dependencies:

   npm install

Configuration

1. Rename the .env.example file to .env and configure the necessary environment variables.

2. Configure your MongoDB connection in the prisma/schema.prisma file.

Usage

1. Start the development server:

   npm run dev

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

3. Register a new account or log in if you already have one.

4. Start enjoying real-time conversations with your contacts!

Contributing

We welcome contributions to improve our chat app. To contribute:

1. Fork the repository.

2. Create a new branch: git checkout -b feature/your-feature-name.

3. Make your changes and commit them: git commit -m "Add your feature description".

4. Push to the feature branch: git push origin feature/your-feature-name.

5. Open a pull request, describing your changes and the problem they solve.

License

This project is licensed under the MIT License.

---

Thank you for choosing our chat app! If you have any questions or need assistance, feel free to contact us. We hope you enjoy using our app as much as we enjoyed building it!