Convos

[![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.