Peptide Retention API

Hello! This doc contains instructions for setting up the API.

For information about what the API does and how to use it, please refer to the wiki

If you want to contribute, make sure you read CONTRIBUTING.md before commiting

Requirements:

• perlbrew with Perl v5.22

• Debian-based Linux

• Postgres 9.6

• Redis

Setup

You will need a running Postgres instance to begin.

Build the app dependencies with:

$ ./bin/build-app

Make sure you do not run this as root! But as a user with sudo access. This will install perlbrew and call the command: cpanm -nlv --installdeps . which reads all of the Perl dependencies listed in the cpanfile and builds them.

Add this line to your ~/.bash_profile:

source ~/perl5/perlbrew/etc/bashrc

Open your Postgres instance and run the commands in db/schema.sql.

Ensure all of the tests pass:

$ PLACK_ENV=development prove -lv xt/
$ PLACK_ENV=development prove -lv t/

Seeding the database

Unzip the files:

$ tar -xvzf data/seed/seed_data.tar.gz 

Run the script:

$ PLACK_ENV=development perl dev-bin/seed.pl

Web Server

The web server runs on Dancer and Starman and uses REST end points

The web server doesn't run in the background and produces output so be sure you have multiple shells or [tmux screen] sessions running

Fire the web server:

PLACK_ENV=development starman bin/app.pl

You must specify the PLACK_ENV, right now only development is supported

This should bind the server to: http://0.0.0.0:5000

In another shell, hit the healthcheck enpoint:

curl -X GET http://0.0.0.0:5000/healthcheck

Please report any issues you have with the setup.

If everything goes smoothly, see the wiki for more information