|
@@ -26,13 +26,10 @@ Available features include:
|
|
|
|
|
|
## 🚀 Deployment
|
|
|
|
|
|
-First, install Rye by following
|
|
|
-the [installation guide](https://rye.astral.sh/guide/installation/).
|
|
|
-
|
|
|
-Then, clone repository:
|
|
|
+Clone repository:
|
|
|
|
|
|
```sh
|
|
|
-git clone https://git.vern.cc/cobra/rural-dict
|
|
|
+git clone https://git.vern.cc/cobra/rural-dict.git
|
|
|
cd rural-dict
|
|
|
```
|
|
|
|
|
@@ -46,9 +43,10 @@ docker compose up -d
|
|
|
### 💻 Without containerization
|
|
|
|
|
|
```sh
|
|
|
-rye sync --no-dev
|
|
|
-rye run uvicorn app.__main__:app --no-access-log --proxy-headers \
|
|
|
- --forwarded-allow-ips '*' --host 0.0.0.0 --port 5758
|
|
|
+python3 -m venv .venv
|
|
|
+. .venv/bin/activate
|
|
|
+pip install -r requirements.lock
|
|
|
+uvicorn src.main:app --no-access-log --proxy-headers --forwarded-allow-ips '*' --host 0.0.0.0 --port 5758
|
|
|
```
|
|
|
|
|
|
### 🛡️ Running behind a reverse proxy
|
|
@@ -68,6 +66,9 @@ location / {
|
|
|
|
|
|
## 🔧 Development
|
|
|
|
|
|
+Install Rye by following
|
|
|
+the [installation guide](https://rye.astral.sh/guide/installation/).
|
|
|
+
|
|
|
Use `rye sync` to install dependencies and required Python version.
|
|
|
|
|
|
Use `rye run dev` to start development server which will reload on every change to source code.
|