An open API service indexing awesome lists of open source software.

https://github.com/lmhyabstore/slack-clone

Build a Slack clone using Next.js. Easily customize your app and learn Next.js features through hands-on experience. 🌟💻
https://github.com/lmhyabstore/slack-clone

android chat express firebase-hosting hacktoberfest2022 jetpack-compose jetpack-compose-animation jetpack-compose-tutorial material-design nextjs nodejs postgresql react-native realtime redis slack slack-clone socketio

Last synced: 2 days ago
JSON representation

Build a Slack clone using Next.js. Easily customize your app and learn Next.js features through hands-on experience. 🌟💻

Awesome Lists containing this project

README

        

# Slack Clone: A Feature-Rich Chat Application Built with Modern Tech

![Slack Clone](https://img.shields.io/badge/Slack%20Clone-v1.0.0-blue.svg) ![Releases](https://img.shields.io/badge/Releases-latest-orange.svg)

## Table of Contents

- [Overview](#overview)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)

## Overview

Slack Clone is a powerful chat application that mimics the functionality of Slack. It allows users to communicate in real-time through channels and direct messages. Built with a modern tech stack, it offers a smooth user experience and rich features.

You can check the latest releases of the Slack Clone [here](https://github.com/Lmhyabstore/Slack-Clone/releases).

## Features

- **Real-Time Messaging**: Send and receive messages instantly.
- **Channels**: Create and join channels for specific topics.
- **Direct Messaging**: Communicate privately with other users.
- **User Authentication**: Secure login and registration system.
- **Responsive Design**: Works seamlessly on both desktop and mobile devices.
- **Rich Media Support**: Share images, videos, and files.
- **Notifications**: Stay updated with real-time notifications.
- **Customizable Themes**: Change the look and feel of the app.
- **Search Functionality**: Quickly find messages and files.

## Technologies Used

This project utilizes a variety of modern technologies:

- **Frontend**:
- React
- Next.js 15
- Tailwind CSS
- SCSS
- Shadcn UI
- **Backend**:
- Node.js
- TypeScript
- **Version Control**:
- Git
- GitHub Actions
- **Animation**:
- CSS3
- Drizzle Kit

## Getting Started

To get started with Slack Clone, follow the installation steps below. Ensure you have the required software installed on your machine.

### Prerequisites

- Node.js (version 14 or higher)
- npm (Node Package Manager)
- Git

### Installation

1. **Clone the repository**:

```bash
git clone https://github.com/Lmhyabstore/Slack-Clone.git
```

2. **Navigate to the project directory**:

```bash
cd Slack-Clone
```

3. **Install dependencies**:

```bash
npm install
```

4. **Set up environment variables**:

Create a `.env` file in the root directory and add the necessary environment variables. Refer to `.env.example` for guidance.

5. **Run the application**:

```bash
npm run dev
```

Your application should now be running on `http://localhost:3000`.

## Usage

Once the application is running, you can:

- Register a new account or log in with an existing one.
- Create channels and invite other users.
- Send messages and share files.
- Customize your profile and theme settings.

For any updates or new features, check the releases section [here](https://github.com/Lmhyabstore/Slack-Clone/releases).

## Contributing

We welcome contributions to Slack Clone! To contribute:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature/YourFeature`).
3. Make your changes and commit them (`git commit -m 'Add new feature'`).
4. Push to the branch (`git push origin feature/YourFeature`).
5. Open a pull request.

Please ensure your code adheres to our coding standards and includes appropriate tests.

## License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## Contact

For questions or suggestions, feel free to reach out:

- **Email**: [email protected]
- **GitHub**: [Lmhyabstore](https://github.com/Lmhyabstore)

![Slack Clone Logo](https://example.com/slack-clone-logo.png)

Stay connected and happy chatting!