Skip to content

Latest commit

 

History

History
84 lines (54 loc) · 2.45 KB

README.md

File metadata and controls

84 lines (54 loc) · 2.45 KB
Raw

Discord Clone

This project is a Discord clone created using a modern tech stack including NextJS 13, Typescript 5, Prisma ORM 5, and Tailwind CSS 3. It aims to imitate the key features of Discord, a popular communication platform, focusing on real-time messaging, voice chat, and community building.

Table of Contents

Installation

To set up and start using this Discord clone, follow these steps:

  1. Clone the repository to your local machine:

    git clone https://github.com/your-username/discord-clone.git

  2. Change to the project directory:

    cd discord-clone

  3. Install the required dependencies:

    npm install

  4. Create a .env file in the root directory and fill in the necessary information as specified in the env.template file.

Contribution

We encourage contributions to enhance this Discord clone. If you're interested in contributing, please adhere to the following guidelines:

  1. Fork the GitHub repository.

  2. Create a new branch for your features or fixes:

    git checkout -b my-feature-branch

  3. Implement your changes while ensuring they comply with the project's coding standards.

  4. Commit your changes with clear and concise commit messages:

    git commit -m "Detailed description of changes"

  5. Push your changes to your fork:

    git push origin my-feature-branch

  6. Create a pull request explaining your changes and their importance.

Usage

After setting up the project, you can run the development server:

npm run dev

This command will host the application locally, typically at http://localhost:3000, allowing you to interact with your local version of the Discord clone.

Technologies Used

  • NextJS 13: For server-side rendering and static site generation.
  • Typescript 5: For adding strong typing to JavaScript, enhancing code quality and maintainability.
  • Prisma ORM 5: As an Object-Relational Mapper to interact with the database.
  • Tailwind CSS 3: For utility-first styling and responsive design.

License

This Discord clone is released under the MIT License. You are free to use, modify, and distribute the code as per the terms of the license.

For more information or queries, feel free to contact [maintainer's email/contact].