Task #1

convos-chat#577

Remember your job is to make incremental progress, break the task into smaller tasks, or finish something in 15 minutes, then pass it along to the next contributor. No responsibility, only fun.

If you don't finish, add your next task to the readme.md. Oh and when you're done make a pull request to the code-relay repo.

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 for more details.

The backend is powered by Mojolicious, while the frontend is held together by the progressive JavaScript framework Svelte.

Quick start guide

See "Getting started" for other options and more information.

Install locally

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 and start chatting.

Docker install

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

docker pull convos/convos:stable
mkdir -p $HOME/convos/data
docker run -it -p 8080:3000 -v $HOME/convos/data:/data convos/convos:stable

Note that Nordaaker/convos will be around for a while, but the new official image is "convos/convos".

How to make a release

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

# 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

alpha

THe "alpha" branch branch will be force pushed to when we need to make a new docker build with working assets, but with experimental features. Example:

git checkout -b user/some-feature
$EDITOR assets/store/Conversation.js
./script/convos build
git add .
git commit -a -m "made some experimental changes"
git push origin -f user/some-feature:alpha

master

"master" 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" 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.

www.convos.chat

"www.convos.chat" is the source for http://convos.chat, which is powered by the built-in CMS In Convos.