Skip to content

#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.

Notifications You must be signed in to change notification settings

brunog3/matrix

 
 

Repository files navigation

Welcome to Matrix

Maintainability CircleCI

What's Matrix

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

When we are working remotely there is no talks like a fisical office. The Matrix project was born how a proposal to better that experiênce. The idea is create a lot of virtual rooms where the people can see and enter in that 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:

  1. Run appplication with docker compose:

     $ docker-compose up -d
    
  2. Open your brownser and access:

     http://localhost:8080/
    
  3. When you finish, you can run:

     $ docker-compose down
    

On Heroku

If you prefer, you can run Matrix in Heroku:

Deploy

Environments

The Matrix project has some environments that important to define.

  1. We are using Google to authorizations, you need create a credential here and before define this:

     GOOGLE_CREDENTIAL=${paste_your_credention_here}
    
  2. It's importante configure SSL, to define this:

     ENFORCE_SSL=true
    
  3. The Matrix needs to know, where it get rooms definitions:

     	ROOMS_SOURCE=environment
    
  4. There is a config that define the rooms of The Matrix, if you prefer you can generate [here] (https://www.uuidgenerator.net), to define this:

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

Contributing

We encourage you to contribute to The Matrix!

Everyone interacting in Matrix codebase, issue trackers, chat rooms, and mailing lists is expected to follow code of conduct.

License

The Matrix is released under the MIT License

"The answer is out there, Neo, and it's looking for you, and it will find you if you want it to."

About

#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.

Resources

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 91.7%
  • HTML 3.8%
  • CSS 3.6%
  • Other 0.9%