Minimalistic Discord Chat App

Minimalistic Discord with just the necessary features 😻😎

View Demo . Report Bug . Request Feature

Table Of Contents

• About the Project
• Built With
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• License
• Authors
• Show your support

About The Project

The shricord-chat project is a minimalistic Discord platform built using Next.js, offering just the necessary features for a seamless user experience.

Built With

• Typescript
• NextJS
• Uploadthing
• TailwindCSS
• Zod
• Zustand
• Socket.io
• Prisma
• React Query
• React Hook Form
• Livekit

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

First of all, you need to have `pnpm`` installed on your machine. You can install it using the following command.

npm install pnpm@latest -g

Installation

🔴 If you wish to setup the project locally, follow the installation instructions.

1. Get all the necessary API keys shown in the .env.example file.

2. Clone the repo

git clone https://github.com/shricodev/shricord-chat.git

3. Install PNPM packages

pnpm install

4. Run the application locally

pnpm run dev

5. (Optional) View the database schema

pnpx prisma studio

Contributing

See the open issues for a list of proposed features (and known issues).

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

• If you have any suggestions, feel free to open an issue to discuss it, or directly create a pull request.
• Please make sure you check your spelling and grammar.
• Create individual PR for each suggestion.

Creating A Pull Request

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache 2.0 License. See License for more information.

Authors

• Shrijal Acharya - Full Stack SDE - Shrijal Acharya - Founder

• Website: https://shricodev.tech
• Twitter: @shricodevv
• Github: @shricodev
• LinkedIn: @shrijal007
• Instagram: @iampiyush.ach

Show your support

Give a ⭐️ if this project helped you!