Giter Club home page Giter Club logo

convos's Introduction

convos Docker Status Build Status GitHub 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 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" is the source for http://convos.chat, which is powered by the built-in CMS In Convos.

convos's People

Contributors

alilles avatar amenonsen avatar bebehei avatar darktohka avatar flexiondotorg avatar ivan-avalos avatar jberger avatar marcusramberg avatar megaf avatar oliwer avatar oxyigyj avatar pink-mist avatar preaction avatar s1037989 avatar serhack avatar tehpegasus avatar thibaultduponchelle avatar tyldum avatar voegelas avatar wikiwide avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.