search

credija / opa

Opa - A modern XMPP Chat Client for the Web
MIT License
83 stars 14 forks source link
chat element-ui emoji nuxt openfire strophejs vue xmpp xmpp-client

readme

Opa - A XMPP Chat Client for the Web

Introduction

Logo Opa

Opa is an open-source XMPP chat client for the Web (SSR) entirely built on top of Vue, NuxtJS and ElementUI that follows the coolest trends out there bye bye Flash and Desktop clients!

Trivia: "Opa", among many meanings in Brazil, is also used informally as a greeting!

Opa boasts a modern design having a clean interface that offers a good user experience. The interface is inspired by numerous web apps that already exist in the Javascript environment, such as WhatsApp Web, Telegram Web, Discord, Rocket Chat, etc... It was born as an internal project to fill the absence of an XMPP client that did not need an installation on each machine, was developed with current techs, had a modern design and supported common features for a chat in a corporate environment.

Opa has a demo available which is at latest version. For testing there are two users:

Username: darth Password: 1234

Username: luke Password: 1234

The demo is available here, have fun: https://www.credija.com.br/opa-demo

Has some feature in mind, suggestion or come across a bug? Open an Issue so we can discuss 👍

Features

Check the features here: https://github.com/credija/opa/wiki/Features

Requirements

Currently Opa uses https://polyfill.io/v3/polyfill.min.js?flags=gated for better support because your browser needs to support these three features:

Also, your XMPP server must support MSM/RSM (for message archiving).

Getting Started

The initial idea of Opa was to be a plug-n-play client to any XMPP server.

Following this you have two ways of running this app:

Installation

NodeJS (From Source)

The installation with NodeJS will need you to install the package manager Yarn. You can install Yarn on an NodeJS environment with this command:

npm install yarn -g

After installing Yarn you will need to clone the project into a folder. This folder will be where the Opa server will run from:

git clone https://github.com/credija/opa.git

After clonning the project you will need to navigate to this folder and run the command below to build and start Opa:

yarn build && yarn start

You will, however, need to connect to your XMPP server. To do that you need to overwrite the /your-project-clone-folder/static/config/app-config.json (explanation of each option in the config file is in Configuration section).

Docker

The installation with Docker is very straightforward. You will, however, need to connect to your XMPP server. To do that you need to overwrite the /app/static/config/app-config.json (explanation of each option in the config file is in Configuration section):

docker run --name opa -d --restart=always \
  --publish 3000:3000 \
  --volume /opt/your-config.json:/app/static/config/app-config.json \
  -m 512MB \
  credija/opa

Configuration

To connect to an XMPP server you will need to overwrite the app-config.json. The options are these:

Internationalization

Opa has a plug-n-play structure for locales, which are stored in /static/locales.

There is right now these languages:

If you want to test Opa but it doesn't have your language you can develop your own translation to the app following the example provided by en-us.json.

Once finished send a pull request on the develop branch with your translation so we can add it to Opa.

Note: It's important to remember that the file needs to follow the 'language-country.json' format which is the same used in the APP_LOCALE option.

Compatibility

Tested Browsers:

Not Tested:

Tested XMPP Servers:

Credits