alessandro trinca tornidor commited on
Commit
e30a902
·
1 Parent(s): 9f7342c

doc: update README.md for STATIC_FOLDER, API_MODE env variables

Browse files
Files changed (1) hide show
  1. README.md +13 -1
README.md CHANGED
@@ -30,7 +30,19 @@ In a Linux/WSL environment (I didn't tried with MacOS or Windows):
30
  * [poetry](https://python-poetry.org/) (`poetry env use 3.12.10`, `poetry install`, `eval $(poetry env activate)`)
31
  * `python -m venv .venv`, `source .venv/bin/activate`, `pip install -r requirements.txt` (and the other requirements files if you need also the webserver and/or the test environment)
32
 
33
- 3. Run the application using `python my_ghost_writer/app.py`
 
 
 
 
 
 
 
 
 
 
 
 
34
 
35
  ## Contributing
36
 
 
30
  * [poetry](https://python-poetry.org/) (`poetry env use 3.12.10`, `poetry install`, `eval $(poetry env activate)`)
31
  * `python -m venv .venv`, `source .venv/bin/activate`, `pip install -r requirements.txt` (and the other requirements files if you need also the webserver and/or the test environment)
32
 
33
+ 3. Run the application using:
34
+ * `python my_ghost_writer/app.py` using the python app.py file path
35
+ * `python -m ghost_writer.app.py` using the python module
36
+
37
+ If using the webserver with the module (`python -m ghost_writer.app.py`) it's necessary one of these env variables:
38
+
39
+ * `STATIC_FOLDER` to define a custom path for the static folder. Probably you should also download the static files:
40
+ * `index.html`
41
+ * `index.js`
42
+ * `index.css`
43
+ * `API_MODE` to avoid mounting the static folder. This will define only the API endpoints
44
+ * `/health`
45
+ * `/words-frequency`
46
 
47
  ## Contributing
48