README.md

Lab 2 PTR (Stream Processing)

A tweet processing system written in Elixir. Eeach week is a version of the system, with Week 1 being the initial version and Week 6 the final one. Each week inbetween is an intermediate week that shows the progress of the system (based on the tasks for each week.)

Check out diagrams/report.md for a way more detailed explanation of the tasks and implementation.

Docker Container

First things first, download the Docker image (IMPORTANT: you need image with the faf18x tag!)

Then start the container:

docker run -p 4000:4000 alexburlacu/rtp-server:faf18x

Starting the Project

Each week has a script. To run the tasks for a particular week, change into the root folder and execute:

mix run lib/week6/script.exs

This will execute the final version of the project (make sure the Docker container is up and running).

Alternatively, to start Elixir's interactive shell loaded with the project execute (from the root folder):

iex -S mix

Formatting

To format, execute:

mix format

Installation

If available in Hex, the package can be installed by adding streamp to your list of dependencies in mix.exs:

def deps do
  [
    {:streamp, "~> 0.1.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/streamp.