update readme.md
All checks were successful
Build and Push Docker Image / build (push) Successful in 22s
All checks were successful
Build and Push Docker Image / build (push) Successful in 22s
This commit is contained in:
@@ -52,6 +52,7 @@ Returns a single random word from the database.
|
|||||||
```
|
```
|
||||||
|
|
||||||
2. **Install dependencies:**
|
2. **Install dependencies:**
|
||||||
|
If you use `uv` you can scip this step.
|
||||||
This project uses `uv` for package management, but standard `pip` works too.
|
This project uses `uv` for package management, but standard `pip` works too.
|
||||||
```bash
|
```bash
|
||||||
pip install -r pyproject.toml
|
pip install -r pyproject.toml
|
||||||
@@ -63,13 +64,13 @@ Returns a single random word from the database.
|
|||||||
Run the initialization script to create `hangman.db` and populate it with the default word list.
|
Run the initialization script to create `hangman.db` and populate it with the default word list.
|
||||||
```bash
|
```bash
|
||||||
python init.py
|
python init.py
|
||||||
|
# OR
|
||||||
|
uv run init.py
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **Start the server:**
|
4. **Start the server:**
|
||||||
```bash
|
```bash
|
||||||
fastapi dev main.py
|
uv run uvicorn main:app --reload
|
||||||
# OR using uvicorn directly:
|
|
||||||
uvicorn main:app --reload
|
|
||||||
```
|
```
|
||||||
The API will be available at `http://localhost:8000/random_word`.
|
The API will be available at `http://localhost:8000/random_word`.
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user