https://github.com/makew0rld/neartalk

NearTalk is chat platform to talk to people nearby.
https://github.com/makew0rld/neartalk

Last synced: about 1 month ago
JSON representation

NearTalk is chat platform to talk to people nearby.

• Host: GitHub
• URL: https://github.com/makew0rld/neartalk
• Owner: makew0rld
• License: agpl-3.0
• Created: 2021-10-31T18:31:49.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-20T16:59:44.000Z (about 1 year ago)
• Last Synced: 2024-10-26T22:25:39.118Z (about 2 months ago)
• Language: Go
• Homepage: https://neartalk.makeworld.space
• Size: 46.9 KB
• Stars: 22
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# NearTalk

Visit [neartalk.makeworld.space](https://neartalk.makeworld.space) to check it out! That server always runs the latest code on the `main` branch.

What is it?



NearTalk is chat platform to talk to people nearby.





Anyone with the same IP address is in the same chat room. For example, everyone

in your house will get the same chat room if they visit NearTalk. If you go to

your local coffee shop, everyone who visit NearTalk will be in the same chat room.

This extends to larger organizations like college/university campuses.





Depending on how the network is set up, all mobile devices using data with the same

network provider as you may be chatting together. Or similarly, all the other homes

using the same ISP. This is the minority of cases however.



Why is it?



For fun, mostly. I wanted to make a chat application and I wanted to use

htmx, and this seemed like a fun idea.





There are many reasons why NearTalk isn't useful, and talking to your fellow humans

face to face

is much better. However there are some times when having a local chatroom is useful,

like for discussing (or dragging) a presentation going on. At the end of the day,

I'm happy to have made something.



## Building

GNU Make is required to use the Makefile. Compiling with `make` automatically embeds version information into the binary from Git, and it's the only supported way to build the project.

Only the latest Go (1.17) is tested, but Go 1.16+ should compile.

## Deploying

You can look at the [neartalk.example.service](./neartalk.example.service) file in the repo as an example for running NearTalk under systemd.

Currently the code does not handle TLS certificates, and so a reverse-proxy is required to use TLS and ensure user security. Make sure you set up your reverse-proxy so that websockets work as well. Just look up ` reverse proxy websocket` to find a configuration.

Currently the code is also designed to work under a domain or subdomain, not a subpath.

Please let me know why you deploy your own instance if you do!

## License

NearTalk is licensed under the [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.en.html). If host your own version, you must release your source code.