3d2a-index/README.md

# 3d2a-index

## Overview

3d2a-index is a webservice and accompanying utilities that indexes and allows you to browse various guncad releases.

## Features

* Self-hostability
* A web-facing UI 
* A search using an actual search index that doesn't suck dick

## How it Works

The webapplication is built on the Django web framework. `guncadindex`

## Building

**TODO**: Write building instructions. Probably gonna be Docker for prod building plus some instructions on instantiating a venv and installing requirements or whatever for dev stuff.

**TODO**: Include notes on these envvars:

* `3D2A_SECRET_KEY` -- must be defined or you'll use an insecure default.

## Deployment

**TODO**: Write up a quick docker-compose or something