Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theshobhitsingh/chat-room
A robust backend of a Chat App built with Node.js and Express, offering RESTful API endpoints for efficient management of chat messages stored in MongoDB.
https://github.com/theshobhitsingh/chat-room
css3 ejs ejs-templates express javascript mongodb mongoose nodejs
Last synced: 2 days ago
JSON representation
A robust backend of a Chat App built with Node.js and Express, offering RESTful API endpoints for efficient management of chat messages stored in MongoDB.
- Host: GitHub
- URL: https://github.com/theshobhitsingh/chat-room
- Owner: theshobhitsingh
- Created: 2024-10-27T06:56:01.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-27T17:45:54.000Z (3 months ago)
- Last Synced: 2024-11-29T13:47:33.780Z (2 months ago)
- Topics: css3, ejs, ejs-templates, express, javascript, mongodb, mongoose, nodejs
- Language: EJS
- Homepage:
- Size: 346 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Chat-Room
A simple Chat Application built with **Express** and **MongoDB**. This application allows users to send and manage chat messages in a user-friendly interface.
## Home Page
## All Chats Section
## Edit Chat Option
## Table of Contents
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [API Endpoints](#api-endpoints)
- [Contributing](#contributing)
## Features
- User-friendly interface for viewing and managing chats.
- Create, Edit, and Delete chat messages.
- Responsive design for mobile and desktop users.
## Technologies Used
- **Node.js** - JavaScript runtime for building the server.
- **Express** - Web application framework for Node.js.
- **MongoDB** - NoSQL database for storing chat messages.
- **EJS** - Templating engine for rendering HTML views.
- **CSS** - Styling the application for a modern look.
## Installation
To get started with the chat application, follow these steps:
1. Clone the repository:
```bash
git clone https://github.com/yourusername/chat-room.git
2. Navigate to the project directory:
```bash
cd chat-application
3. Install the required dependencies:
```bash
npm install
4. Set up your MongoDB database. You can use a local MongoDB server or a cloud-based service like MongoDB Atlas.
5. Create a .env file in the root of the project with the following variables:
(I) makefile
(II) PORT=3000
(III) MONGODB_URI=your_mongodb_connection_string
(IV) Start the application: npm install
6. Open your browser and go to http://localhost:8080.
## Usage
- **Viewing Chats**: Navigate to the "/chats" route to see all chat messages.
- **Adding a Chat**: Use the form on the home page to send a new chat message.
- **Editing a Chat**: Click on "Edit" next to a chat message to update it.
- **Deleting a Chat**: Click the "Delete" button next to a chat message to remove it.
## API Endpoints
### Chats
- **GET /chats**
- Retrieve all chat messages.
- **POST /add-chat**
- Create a new chat message.
- **Body**:
- `from`: Sender's name.
- `to`: Recipient's name.
- `msg`: Message content.
- **POST /edit-chat/:id**
- Update an existing chat message.
- **Parameters**:
- `id`: The ID of the chat message to update.
- **Body**: Same as create.
- **POST /delete-chat/:id**
- Delete a chat message.
- **Parameters**:
- `id`: The ID of the chat message to delete.
## Contributing
Contributions are welcome! To contribute to this project, please fork the repository and submit a pull request with your changes.
1. Fork the repository.
2. Create a new branch for your feature:
```bash
git checkout -b feature/YourFeature
3. Commit your changes:
```bash
git commit -m 'Add some feature'
4. Push to the branch:
```bash
git push origin feature/YourFeature
5. Open a pull request.
## Developer
I develop this project : *Shobhit Singh*