chadlagore/beluga repository overview

⁠beluga

Event tracking, rating and prioritizing for your event going pleasure.

⁠:running: Getting Started

You will need Docker Compose (pip install docker-compose).

docker-compose up  # Or docker-compose start for background.

⁠:shipit: Deployment

The production Dockerfile gets pulled and built from the master branch by DockerHub.

⁠:books: Docs

We use ApiDoc⁠.

npm install apidoc -g

To generate the docs and view them:

apidoc -i beluga/ -o docs
python -m SimpleHTTPServer

Head to the docs folder.

⁠Testing

We use a separate image to run our tests (see tests/Dockerfile). It still uses the docker-compose pattern, because we would like for it to access postgres and redis etc.

docker-compose run test pytest -vvv

It will not run during a call to docker-compose up.