Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nafisrayan/st-publicchat
A streamlit public chatroom for universal users.
https://github.com/nafisrayan/st-publicchat
chat database group group-chat python sqlite streamlit
Last synced: about 5 hours ago
JSON representation
A streamlit public chatroom for universal users.
- Host: GitHub
- URL: https://github.com/nafisrayan/st-publicchat
- Owner: NafisRayan
- Created: 2024-07-29T19:01:33.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-07-30T05:29:46.000Z (4 months ago)
- Last Synced: 2024-07-31T03:28:32.763Z (4 months ago)
- Topics: chat, database, group, group-chat, python, sqlite, streamlit
- Language: Python
- Homepage: https://publicchat.streamlit.app/
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ST-PublicChat
## Overview
ST-PublicChat is a Streamlit-based application designed to provide a platform for universal users to engage in public chat discussions. It allows users to interact in a chatroom environment, facilitating communication and interaction among participants. The application is built using Python and leverages the Streamlit framework for its interactive web interface, making it accessible and easy to use.
## Features
- **Real-time Chatting**: Users can send messages in real-time, which are immediately visible to all participants in the chatroom.
- **User Identification**: Users can enter a username to identify themselves in the chatroom.
- **Message Timestamps**: Each message is timestamped, providing context on when it was sent.
- **News Scraping Feature**: Users can toggle the display of the latest news articles directly within the chatroom. This feature allows for quick access to current events and headlines, enhancing the overall experience of the chatroom.
- **Automatic Database Clearing**: The chatroom messages are automatically cleared every 10 minutes to keep the conversation fresh and manageable.
- **Auto-refresh**: The chatroom auto-refreshes every 3 seconds to ensure users see the latest messages without manual reloading.
## Getting Started
To get started with ST-PublicChat, follow these steps:
### Prerequisites
- Ensure you have Python installed on your system.
- Install Streamlit if you haven't already, by running `pip install streamlit` in your terminal.
### Installation
1. Clone the repository:
```
git clone https://github.com/yourusername/ST-PublicChat.git
```
Replace `yourusername` with the actual username where the repository is hosted.
2. Navigate to the project directory:
```
cd ST-PublicChat
```
3. Install any required packages listed in `requirements.txt`:
```
pip install -r requirements.txt
```
### Running the Application
To run the application, execute the following command in your terminal:
```
streamlit run app.py
```
This will start the Streamlit server and open the chatroom in your default web browser.
## Usage
Upon launching, you'll be greeted with the chatroom interface. Here's how to use it:
- **Username**: Enter your desired username in the provided text input field.
- **Sending Messages**: Type your message in the 'Type your message here' input box and click 'Send Message' to post it to the chatroom.
- **Viewing Messages**: The chatroom displays messages along with usernames and timestamps. Messages are shown in descending order, with the most recent messages appearing first.
## Using the News Scraping Feature
Within the chatroom interface, you'll find a button labeled 'Manage News'. Clicking this button will toggle the display of the latest news articles. If the feature is turned on, you'll see the most recent news articles below the chatroom. Clicking the button again will turn off this feature, hiding the news articles until you enable it once more.
## Database
The application uses SQLite for storing messages. The database (chat.db) and a file (last_clear.txt) for tracking the last clear time are automatically created and managed by the application. The database is cleared every 10 minutes to keep the chatroom fresh, ensuring that the conversation remains relevant and uncluttered.
## Contributing
Contributions are welcome! Feel free to fork the repository, make your changes, and submit a pull request.
## Contact
For any questions or suggestions, feel free to open an issue or contact the maintainers.
## Acknowledgments
- Streamlit for making web app development simple and intuitive.
- SQLite for providing a lightweight database solution.
## Disclaimer
This project is for educational purposes and is not intended for production use without further development and security considerations.