added readme and license files

surajprojects · surajprojects · commit 504958c1fc30 · 2025-02-12T17:28:00.000+05:30
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Suraj Chauhan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,52 @@
+---
+
+# Basic Chat App
+
+This is a real-time chat application built using WebSockets, allowing users to create or join chat rooms and exchange messages with other members in the same room.
+
+## Features
+
+- **Create or Join Rooms**: Users can either create a new chat room or join an existing one.
+- **Real-Time Messaging**: Messages are instantly shared with all members in the same room.
+- **Room Isolation**: Messages are not shared across different rooms.
+- **WebSockets for RTC**: Enables real-time communication without page refresh.
+
+## Technologies Used
+
+### Frontend:
+- **HTML, CSS, JavaScript**: For building a simple and responsive UI.
+- **GitHub Pages**: Used for hosting the frontend.
+
+### Backend:
+- **Node.js & Express.js**: Handles server-side logic.
+- **Native HTTP Server**: Used alongside Express.js for efficient handling.
+- **WebSockets**: Enables real-time bidirectional communication.
+- **Render.com**: Used for hosting the backend.
+
+## Deployment
+
+- **Frontend**: Hosted on GitHub Pages - [Chat App Frontend](https://surajprojects.github.io/basic-chat-app)
+- **Backend**: Hosted on Render - [Chat App Backend](https://basic-chat-app-57al.onrender.com)
+
+## Getting Started
+
+To run the project locally:
+
+For the frontend:
+
+1. Clone this repository.
+2. Navigate to the frontend folder.
+3. Open `index.html` in your browser using serve npm package.
+
+For the backend:
+
+1. Navigate to the backend folder.
+2. Install dependencies using `npm run build`.
+3. Start the server with `npm run start`.
+4. The server runs on `http://localhost:3000`.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+---
diff --git a/frontend/favicon.ico b/frontend/favicon.ico
diff --git a/frontend/index.html b/frontend/index.html
@@ -6,6 +6,7 @@
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <title>Basic Chat App</title>
     <link rel="stylesheet" href="styles.css">
+    <link rel="icon" href="favicon.ico" type="image/x-icon">
 </head>
 
 <body>
