API Tutorial

This tutorial is only for use on the CS Virtual Machine.

The following instructions may not work if your machine is improperly configured. Instructions for downloading the VM can be found here: https://howto.cs.uchicago.edu/vm:install

Setup

Clone our repository into a new directory using:
$ git clone https://github.com/cmsc22000-project-2018/api.git

Redis Installation

To install Redis, run the following commands in your new directory:
$ wget http://download.redis.io/releases/redis-4.0.9.tar.gz
$ tar xzf redis-4.0.9.tar.gz
$ cd redis-4.0.9
$ make

Hiredis Installation

To install Hiredis, clone the Hiredis repository into the directory containing your tests using:
$ git clone https://github.com/redis/hiredis.git

You will need to configure Hiredis before use. To do so, run the following inside the Hiredis directory:
$ sudo make install
Enter the VM password, which should be uccs.
$ sudo ldconfig

Return to the testing directory.

Running Hiredis

In another window, enter the redis-4.0.9 directory and establish a connection to Redis with the following command:
$ src/redis-server

...And that's it! You should be properly configured and ready to go.