https://github.com/convos-chat/convos

Convos :busts_in_silhouette: is the simplest way to use IRC in your browser
https://github.com/convos-chat/convos

chat irc irc-client mojolicious perl web-app

Last synced: 1 day ago
JSON representation

Convos :busts_in_silhouette: is the simplest way to use IRC in your browser

• Host: GitHub
• URL: https://github.com/convos-chat/convos
• Owner: convos-chat
• License: artistic-2.0
• Created: 2013-11-30T14:57:15.000Z (about 11 years ago)
• Default Branch: main
• Last Pushed: 2024-12-19T22:42:04.000Z (23 days ago)
• Last Synced: 2025-01-03T10:02:27.463Z (9 days ago)
• Topics: chat, irc, irc-client, mojolicious, perl, web-app
• Language: Perl
• Homepage: http://convos.chat
• Size: 50.8 MB
• Stars: 1,049
• Watchers: 33
• Forks: 85
• Open Issues: 32
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-starred - convos-chat/convos - Convos :busts_in_silhouette: is the simplest way to use IRC in your browser (perl)

README

        
[![convos](https://snapcraft.io//convos/badge.svg)](https://snapcraft.io/convos)

[![Build Status](https://github.com/convos-chat/convos/workflows/Linux%20CI/badge.svg?branch=main)](https://github.com/convos-chat/convos/actions)

[![GitHub issues](https://img.shields.io/github/issues/convos-chat/convos)](https://github.com/convos-chat/convos/issues)

# Convos - Multiuser chat application

Convos is a multiuser chat application that runs in your web browser.

The supported chat protocol is currently IRC, but Convos can be extended to

support other protocols as well.

See [convos.chat](http://convos.chat) for more details.

The backend is powered by [Mojolicious](http://mojolicious.org), while the

frontend is held together by the progressive JavaScript framework

[Svelte](https://svelte.dev/).

## Quick start guide

See "[Getting started](https://convos.chat/doc/start)" for other

options and more information.

### Install locally

```bash

curl https://convos.chat/install.sh | sh -

./convos/script/convos daemon

```

That's it! After the two commands above, you can point your browser to

[http://localhost:3000](http://localhost:3000) and start chatting.

### Docker install

You can use the command below to pull and run convos:

```bash

docker pull ghcr.io/convos-chat/convos:alpha

mkdir -p $HOME/convos/data

docker run -it -p 8080:3000 -v $HOME/convos/data:/data ghcr.io/convos-chat/convos:alpha

```

Note that [Nordaaker/convos](hub.docker.com/r/Nordaaker/convos/) and

[convos/convos](https://hub.docker.com/r/convos/convos) will be around

for a while, but the new official image is now hosted at

[GitHub](https://github.com/convos-chat/convos/pkgs/container/convos).

## How to make a release

Notes for developers so a new release is made in a proper way.

```bash

# Update with the recent changes and make sure the timestamp is proper

$EDITOR Changes

# Build the production assets and update and check that all the files

# have the correct version information

./script/convos build release

```

## Branch overview

### main

"[main](https://github.com/convos-chat/convos/tree/main)" is for

developers. It's mostly stable, but might require extra tools and packages to

run. This branch might have outdated assets (JavaScript, CSS files), so it

might not work properly.

### stable

"[stable](https://github.com/convos-chat/convos/tree/stable)" is the branch you

should use, if you want to clone and run Convos. The JavaScript assets and the

Perl code will be in sync here.