murijr / matrix Goto Github PK

View Code? Open in Web Editor NEW

#matrix is the online open-source workplace for distributed teams to have the experience of work together each day, side-by-side. No matter where team members might be. Working an online workplace office is even more productive when people feeling in the same space.

JavaScript 92.26% HTML 3.60% Dockerfile 0.60% CSS 3.32% Shell 0.22%

matrix's Introduction

Welcome to Matrix

What's Matrix

The objective of Matrix project is to offer a virtual environment office, as nice as fisical offices. When we are working in a fisical office is very common entering in discussion threads in many diferents environments, for example: On coffe, On lunch and others.

When we are working remotely there are no conversations like in a fisical office. The Matrix project was born as a proposal to better that experience. The idea is to create a lot of virtual rooms where people can see and enter these rooms to participate.

Matrix produces a virtual office for remote teams. In this project, you can run a virtual office to simulate the physical environment. Read more here

Getting Started

If you want run the Matrix, you need follow steps:

Run appplication with docker compose:
```
 $ docker-compose up -d
```
Open your brownser and access:
```
 http://localhost:8080/
```
When you finish, you can run:
```
 $ docker-compose down
```

On Heroku

If you prefer, you can run Matrix in Heroku:

Environments

The Matrix project has some environments that important to define.

We are using Google to authorizations, you need create a credential here and before define this:
```
 GOOGLE_CREDENTIAL=${paste_your_credention_here}
```
It's importante configure SSL, to define this:
```
 ENFORCE_SSL=true
```
The Matrix needs to know, where it get rooms definitions:
```
 ROOMS_SOURCE=environment
```

There is a config that define the rooms of The Matrix, if you prefer you can generate here, to define this:

 ROOMS_DATA=[
    {
       "id":"${UUID}",
       "name":"Lounge",
       "disableMeeting":true
    },
    {
       "id":"${UUID}",
       "name":"WAR ROOM CDP"
    },
    {
       "id":"${UUID}",
       "name":"Data Services"
    }
  ]