24 lines
603 B
Markdown
24 lines
603 B
Markdown
# 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.
|
|
|
|
## 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.
|
|
|
|
## Deployment
|
|
|
|
**TODO**: Write up a quick docker-compose or something
|