Skip to content

Commit a6207ff

Browse files
committed
Update README with additional instructions
1 parent fb471ca commit a6207ff

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This is a CAT to work with texts. Now in experimental stage. Uses Python and
44
Quart as a backend library.
55

6-
## Running the server
6+
## Running the development server
77

88
To run development server navigate to `backend` directory and create virtual
99
environment:
@@ -13,8 +13,29 @@ python3 -m venv .venv
1313
source .venv/bin/activate
1414
```
1515

16+
Install all dependencies:
17+
18+
```bash
19+
pip install -r requirements.txt
20+
```
21+
1622
Then run Quart dev server:
1723

1824
```bash
19-
python3 app.py
25+
python3 app/app.py
2026
```
27+
28+
## Running the production version
29+
30+
To run production version of the tool you need to use `docker compose`:
31+
32+
```bash
33+
docker-compose up -d --build
34+
```
35+
36+
This will build all needed images and run services in detached mode. Please
37+
note that reverse proxy is listening to `80` port on the localhost, so you need
38+
to set up something to listed on the domain name if you need.
39+
40+
The production version is located (or will be if not yet) at
41+
https://hat.codecliffs.ru

0 commit comments

Comments
 (0)