# taar-api

**Repository Path**: mirrors_mozilla/taar-api

## Basic Information

- **Project Name**: taar-api
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-22
- **Last Updated**: 2026-03-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Taar Api

[![CircleCI](https://img.shields.io/circleci/project/github/mozilla/taar-api/master.svg)](https://circleci.com/gh/mozilla/taar-api)
[![codecov](https://codecov.io/gh/mozilla/taar-api/branch/master/graph/badge.svg)](https://codecov.io/gh/mozilla/taar-api)

Dockerflow cookiecutter contains all the boilerplate you need to create a Dockerflow-compliant project.


## Instructions for development

0. Make sure you have [docker](https://docker.io) and [docker-compose](https://github.com/docker/compose)
1. make up

## Instructions for deployment

The target environment for this project follows the [dockerflow](https://github.com/mozilla-services/Dockerflow) conventions.
In order to run it correctly, a number of environment variables needs to be set up.
The full list of variables can be found in the web section of the docker-compose.yml file.
From a services standpoint, this project requires:
 - a Postgres db to store the application data, defined by DATABASE_URL
 - an optional Redis cache service, defined by CACHE_URL

### Updating Taar

The core of taar-service lives in the [mozilla-taar](https://pypi.python.org/pypi/mozilla-taar) python package.
These are the steps required to deploy a new version of mozilla-taar on taar-api using [hashin](https://pypi.python.org/pypi/hashin):

From the root of the repository:

```bash
hashin mozilla-taar==<major>.<minor>.<patch>
```
Then open a pull request with the changes to requirements.txt. Once it's merged to master, the taar api dev service will automatically
update.