1# TNTVillage Search Tool
 2
 3## Instructions
 4
 5First, make sure to clone everything correctly:
 6```
 7git clone https://github.com/BiRabittoh/tnt-search
 8cd tnt-search
 9git submodule init
10git submodule update
11```
12
13### Bare metal
14```
15python3 -m venv venv
16source venv\bin\activate
17pip install --upgrade pip
18pip install -r requirements.txt
19waitress-serve --host 127.0.0.1 --port 5000 main:app
20```
21
22### Docker
23
24Either use Docker CLI:
25```
26docker build -t tnt-search .
27docker run -d --name tnt-search --restart unless-stopped -p 5000:5000 tnt-search
28```
29
30Or, better, `docker-compose`:
31```
32docker-compose up -d
33```