README.md

# Introduction

This is a flask application that leverages [RabbitMQ](https://www.rabbitmq.com/) and [Celery](https://docs.celeryproject.org/en/latest/getting-started/introduction.html)

to asynchronously create a Cheaha user account. Currently the project is being developed on an Openstack cluster.

# Project Setup

Since this project is currently being developed only on an Openstack cluster all you will need to do to get started is to either create a new cluster referencing the steps  [here](https://gitlab.rc.uab.edu/rc/cod-heat-stack) or work off of your existing one that will already have everything set up as part of the cluster creation through ansible. 


# Run Project

The project should already be running if your cluster deployment ran completely and correctly. You will need to edit your hosts file to point to the node you are wanting to work on if you haven't already done so in your cluster setup. 

From here you can confirm that the account-app is working by navigating to yourname.rc.uab.edu/account-app. 



For an example of how the account-app/rabbitmq-agents workflow progresses please refer to this chart ![chart](/docs/images/rabbitmq-agents-flowchart.png)
and this for information about the messages being sent ![](/docs/images/rabbitmq-agents-messages.png)


# Contribute to Project

To begin you will need to navigate to /var/www/ood/register/register/account \(this may change in the future when upstream projects are updated to allow custom repos/project names to be injected\) and checkout your branch. From here you will also need to run `git config --global user.name "Your Name"` and `git config --global user.email "you@example.com"` to make sure that your commits will be properly tracked.