rar-index-py/README.md

# RAR-Index
It's some project for my school which is supposed to index _rar_-archives and make them searchable over a very ugly web frontend.

## Downloading
```bash
git clone https://git.marcelsite.com/marcel/rar-index
cd rar-index
```

## Usage
### Baremetal
Install the dependencies:
```bash
pip install -r requirements.txt
```
Edit the configuration:
```bash
cd flask
cp example.config.py config.py
$EDITOR config.py
```
Start the server:
```bash
python app.py
```

### Docker
TBA

## Contributing
I don't recommend wasting your time on this project. It is only created to get a (hopefully) good grade in school.