Hulse Stream Server

Server connecting clients (consumers) and hosts (producers) allowing them to seamlessly run queries.

Getting Started

Clone the application:

git clone [email protected]:hulsedev/stream-server.git
cd stream-server

Next, create a virtual env & install dependencies:

python -m venv env
source env/bin/activate
pip install -r requirements.txt

Note that these instructions on db setups are the same as for getting started with the api-server, if you already completed those, feel free to skip these.

You will then need to setup your local Postgres database:

sudo -u postgres psql

Once you're connected to the postgres shell, run the following commands:

CREATE DATABASE "hulse-api";
CREATE USER postgres WITH PASSWORD 'postgres';
ALTER ROLE postgres SET client_encoding TO 'utf8';
ALTER ROLE postgres SET default_transaction_isolation TO 'read committed';
ALTER ROLE postgres SET timezone TO 'UTC';
GRANT ALL PRIVILEGES ON DATABASE hulse-api TO postgres;

Find more info about setting postgresql with django here.

Running locally

You can directly run the app using the following script:

bash scripts/create-superuser.sh
bash scripts/run-debug-server.sh

For more info on running things locally, check out the local integration test example showcased in the tests/README.md file.

Deployment

The app is currently deployed on Heroku using free dynos (free credits). You can find the Heroku deployment instructions in the Procfile.