{"id":20137395,"url":"https://github.com/thund3rhawk/chatbreeze","last_synced_at":"2025-03-02T23:12:22.893Z","repository":{"id":242476700,"uuid":"809647480","full_name":"Thund3rHawk/ChatBreeze","owner":"Thund3rHawk","description":"FullStack chat application","archived":false,"fork":false,"pushed_at":"2025-02-16T09:26:54.000Z","size":699,"stargazers_count":3,"open_issues_count":2,"forks_count":2,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-16T10:26:51.884Z","etag":null,"topics":["expressjs","mongodb-atlas","nextjs14","node-typescript","prisma-orm","shadcnui","socket-io","tailwindcss","typescript"],"latest_commit_sha":null,"homepage":"https://chatbreeze.vercel.app/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Thund3rHawk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-03T07:19:27.000Z","updated_at":"2025-02-16T09:38:49.000Z","dependencies_parsed_at":"2024-06-03T09:12:14.328Z","dependency_job_id":"56e8ac48-a69a-4a0c-a41b-4060495e2be0","html_url":"https://github.com/Thund3rHawk/ChatBreeze","commit_stats":null,"previous_names":["thund3rhawk/chatbreeze"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thund3rHawk%2FChatBreeze","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thund3rHawk%2FChatBreeze/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thund3rHawk%2FChatBreeze/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Thund3rHawk%2FChatBreeze/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Thund3rHawk","download_url":"https://codeload.github.com/Thund3rHawk/ChatBreeze/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241582555,"owners_count":19985845,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["expressjs","mongodb-atlas","nextjs14","node-typescript","prisma-orm","shadcnui","socket-io","tailwindcss","typescript"],"created_at":"2024-11-13T21:27:33.031Z","updated_at":"2025-03-02T23:12:22.888Z","avatar_url":"https://github.com/Thund3rHawk.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"🚀 ChatBreeze\n=============\n\nWelcome to **ChatBreeze**, a full-stack real-time chat application built with modern web technologies. This app supports multiple users, private and group messaging, and is designed to be **scalable** and **maintainable**. 💬✨\n\n📜 Table of Contents\n--------------------\n\n*   [🌟 Features](#-features)\n*   [🛠️ Technologies Used](#️-technologies-used)\n*   [⚙️ Environment Variables](#️-environment-variables)\n*   [💻 Run Locally](#-run-locally)\n*   [🚀 Usage](#-usage)\n*   [🤝 Contributing](#-contributing)\n*   [📜 License](#-license)\n    \n\n🌟 Features\n-----------\n\n*   **Real-time Messaging** 🔥\n*   **User Authentication and Authorization** 🔐\n*   **Two-Step Verification** 🔄\n*   **Profile Management** 📝\n*   **Message Notifications** 🔔\n    \n\n🛠️ Technologies Used\n---------------------\n\n*   **Frontend**:\n    \n    *   [Next.js](https://nextjs.org/)\n    *   [Tailwind CSS](https://tailwindcss.com/)\n        \n*   **Backend**:\n    \n    *   [Node.js](https://nodejs.org/)\n    *   [Express](https://expressjs.com/)\n    *   [Socket.IO](https://socket.io/)\n    *   [Prisma ORM](https://www.prisma.io/)\n        \n*   **Database**:\n    \n    *   [MongoDB](https://www.mongodb.com/)\n        \n\n\n⚙️ Environment Variables\n------------------------\n\nTo configure the application, set up the following environment variables:\n\n### 🔹 Frontend (Website)\n\nCreate a .env file in the apps/website directory with:\n\n`   NEXT_PUBLIC_API_ENDPOINT=http://localhost:8080   `\n\n### 🔹 Backend (Server)\n\nCreate a .env file in the **root** directory with:\n\n`   PORT=8080 `\n\n` DATABASE_URL=mongodb+srv://:@/chatbreeze?  `\n\n`AUTH_EMAIL=  \u003cyour_email\u003e`\n\n`AUTH_EMAIL_PASS= \u003cyour_auth_email_password\u003e  `\n\nReplace _\u003cusername\u003e_, _\u003cdb_password\u003e_, _\u003chost\u003e_, _\u003cyour_email\u003e_, and _\u003cyour_auth_email_password\u003e_ with your actual credentials.\n\n💻 Run Locally\n--------------\n\n### Prerequisites\n\nEnsure you have the following installed:\n\n*   **Node.js** (\u003e=18.x) 🟢\n*   **MongoDB** 🍃\n*   **Git** 🔗\n    \n\n### Clone the Repository\n\n`   git clone https://github.com/Thund3rHawk/ChatBreeze.git `\n\n` cd ChatBreeze   `\n\n### Install and Run the Backend\n\n`   npm install `\n\n` npx prisma generate `\n\n` npm run dev   `\n\n### Install and Run the Frontend\n\nOpen another terminal:\n\n`   cd apps/website `\n\n` npm install `\n\n` npm run dev   `\n\nThe frontend should now be running at **http://localhost:3000.**\n\n🚀 Usage\n--------\n\n*   **Sign Up or Log In**: New users can sign up and verify their email using an OTP. Existing users can log in with their credentials.\n*   **Create or Join Chats**: Start a chat by searching for a user by their email.\n*   **Send Messages**: Type and send messages in real-time. Receive notifications for new messages.\n    \n\n🤝 Contributing\n---------------\n\nContributions are always welcome! Please refer to the [CONTRIBUTING.md](https://github.com/Thund3rHawk/ChatBreeze/CONTRIBUTING.md) file for guidelines on how to contribute. 🚀\n\n📜 License\n----------\n\nThis project is licensed under the **MIT License**. See the [LICENSE](https://github.com/Thund3rHawk/ChatBreeze/blob/main/LICENSE) file for more details. 📄","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthund3rhawk%2Fchatbreeze","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthund3rhawk%2Fchatbreeze","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthund3rhawk%2Fchatbreeze/lists"}