sghorbal commited on
Commit
4dacb34
·
1 Parent(s): 7f79e52

update app description

Browse files
Files changed (1) hide show
  1. README.md +11 -4
README.md CHANGED
@@ -12,22 +12,29 @@ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-
12
 
13
  # tennis-api
14
 
 
 
15
  ## Docker Install
16
 
17
- To get the service for training the model and giving predictions up and running locally, simply follow the steps hereafter:
18
 
19
  ### Build the API image
20
 
21
- From the root of the project:
22
  ```bash
23
  $> docker build . -t tennis_api:latest -f Dockerfile
24
- ```
 
 
 
 
 
25
 
26
  ### Run it
27
 
28
  From the root of the project:
29
  ```bash
30
- $> docker run --rm -p 7860:7860 --mount type=bind,src=./.env,target=/app/.env tennis_api:latest
31
  ```
32
 
33
  Then go to [http://localhost:7860/](http://localhost:7860/)
 
12
 
13
  # tennis-api
14
 
15
+ This module is intended for managing tennis data insertion into the database and providing an interface for data retrieval and tennis match predictions.
16
+
17
  ## Docker Install
18
 
19
+ To get the service up and running locally, simply follow the steps hereafter:
20
 
21
  ### Build the API image
22
 
23
+ From the root of the project:
24
  ```bash
25
  $> docker build . -t tennis_api:latest -f Dockerfile
26
+ ```
27
+
28
+ For building with pytest capabilities, run:
29
+ ```bash
30
+ $> docker build . --build-arg TEST=true -t tennis_api:latest -f Dockerfile
31
+ ```
32
 
33
  ### Run it
34
 
35
  From the root of the project:
36
  ```bash
37
+ $> docker run --rm -p 7860:7860 --env-file .env tennis_api:latest
38
  ```
39
 
40
  Then go to [http://localhost:7860/](http://localhost:7860/)