Welcome

Welcome to the website that will give you an overview and introduction to the project we have been working on. We are eight students from the Royal Institute of Technology in Stockholm, Sweden and we have been assigned to come up with a project that is relevant to our technical education.

Our project idea

Initially we came up with several different good ideas. The first was a peer-to-peer file sharing application. We wanted it to be as easy to use and offer the same functionality as the large cloud storage services that exist today, but without the need to store data through a third party.

The second idea we came up with was a website that would focus solely on letting users engage in political debates. Users could vote for the best argument and the argument with the most number of votes would appear first on the website.

The idea we chose was none of the above. Instead, we came up with something that might be considered a little more difficult, we wanted to develop a network application to make it easier for programmers working on the same project. This application would allow developers to see in real time what other team members are working on and what files they are changing.

Last note

This website is mainly for us and our classmates who want to get an overview of our project. This website contains information about our product, our sprints and who we are.

Overview

Our product Lumi enables real-time inspection of file changes made by all team members. A client connects to the server and creates a room. Other clients can join the room. If a client makes a file change, the update is sent to the server and validated. If approved, the server will send it to the remaining clients in the room.

All this results in a synchronized workflow that minimizes conflicts and makes it easier for programmers to get an overview of what is currently being updated.

Functionality details

Down below is diagram made with Draw.io that describes how the client and server should interact with each other. If you use this diagram, you should be able to implement the base functionality in some programming language.

Command line interface

As a user on the client side, you must be able to communicate with the server in order to create a room, join a room, leave a room and so on. The main tool at your disposal will be the command line interface.

To install the command line interface for Lumi enter the following command in your shell.

$ npm i -g lumi-cli

Note that you need npm installed before you can download and use Lumi.

After you have installed Lumi you should be able to ping the server using the following command.

$ lumi ping

Then we could ask the server to create a new room using the following command. The server should respond with a unique room id.

$ lumi create

If we would like to join an already created room we can use the following command.

$ lumi join <room id>

If we would like to check whether a room exists or not we can use the following command.

$ lumi check <room id>

If we don't want to use two separate commands to create and join a room we can use the following command instead.

$ lumi start

This list will be extended over time as we add more functionality.

Select your operating system

Choose the right link depending on your operating system. After clicking on a link, the Lumi GUI (Graphical User Interface) will be downloaded.

Product owner

personErik Rehn

emailerikreh@kth.se

public

Scrum master

personJesse Feng

emailjessef@kth.se

public

Developers

personChristopher Gauffin

emailcgau@kth.se

public

personTobias Johannesson

emailtjohann@kth.se

public

personJoakim Tornert

emailjtornert@kth.se

public

personMicheal Arenander

emailmicare@kth.se

public

personOscar Persson

emailopers@gmail.com

public

personMarcus Alevärn

emailmalevarn@kth.se

public