Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/lyubomirt/alert-chatroom

Chatroom application that lets you create and manage chatrooms right from PC and share them with the world!
https://github.com/lyubomirt/alert-chatroom

chat collaborate discord-alternative group-chat peer-to-peer platform simple website websockets

Last synced: 23 days ago
JSON representation

Chatroom application that lets you create and manage chatrooms right from PC and share them with the world!

Host: GitHub
URL: https://github.com/lyubomirt/alert-chatroom
Owner: LyubomirT
License: gpl-3.0
Created: 2024-07-30T15:50:22.000Z (4 months ago)
Default Branch: main
Last Pushed: 2024-08-31T01:58:56.000Z (3 months ago)
Last Synced: 2024-10-19T02:41:51.101Z (about 1 month ago)
Topics: chat, collaborate, discord-alternative, group-chat, peer-to-peer, platform, simple, website, websockets
Language: JavaScript
Homepage: https://alertchat.jprq.app/
Size: 257 KB
Stars: 10
Watchers: 1
Forks: 5
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

Alert - Chatrooms for Everyone!

[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Made with Node.js](https://img.shields.io/badge/Made%20with-Node.js-green.svg)](https://nodejs.org)
[![Powered by WebSockets](https://img.shields.io/badge/Powered%20by-WebSockets-yellow.svg)](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API)

## What's Alert? 🤔

Alert is a chatroom application that lets you create and manage chatrooms right from your PC and share them with the world! It's like having your own little corner of the internet where you can chat with friends, family, or anyone who's interested.

## Features 🌟

- 🏠 Create chatrooms on your local machine
- 🌐 Expose your chatrooms to the web
- 👥 Real-time messaging with multiple users
- 🔒 Decentralized and private
- 👑 Host controls for managing your room
- 🔍 Discoverable rooms (if you want!)
- 📁 File sharing capabilities
- 😄 Emoji reactions and replies

## How to Access 🔗

You can try out Alert right now at [alertchat.jprq.app](https://alertchat.jprq.app)! Just hop on, create a room or join an existing one, and start chatting!

## Setting Up Locally 🛠️

Want to run Alert on your own machine? No problem! Here's how:

1. Clone this repo:
```
git clone https://github.com/LyubomirT/alert-chatroom.git
```

2. Navigate to the project directory:
```
cd alert-chatroom
```

3. Install dependencies:
```
npm install
```

4. Start the server:
```
npm run start
```

5. Open your browser and go to `http://localhost:3000`

6. Start chatting! 🎉

## Contributing 🤝

We love contributions! If you have ideas for new features or improvements, feel free to:

- Open an issue
- Submit a pull request
- Start a discussion

Let's make Alert even more awesome together!

## Tunneling with JPRQ 🚇

Alert uses [JPRQ](https://jprq.io) to expose the website to the web. JPRQ is a simple, secure, and free tool that lets you tunnel your local servers to the internet. To use JPRQ with Alert, follow these steps:

1. Install JPRQ if you haven't already:
2. Go to `host.ini` and replace "None" with "JPRQ" in "mode"
3. Run the server with `npm run start`
4. Open your browser and go to the JPRQ link provided

## License 📄

This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details.

## Screenshot 📸

![Alert Screenhot.png](readme/screenshot.png)

## Enjoy Alert! 💬

We hope you have a blast using Alert for all your chatroom needs. Whether you're planning a surprise party, hosting a study group, or just hanging out with friends, Alert's got you covered. Happy chatting! 🎈