You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/SETUP.md
+4-37Lines changed: 4 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,41 +65,8 @@ For a production environment running directly with Node.js:
65
65
```bash
66
66
npm start
67
67
```
68
-
69
-
## 5. Importer Usage
70
-
71
-
The importer is a critical component for populating the API's data store. It is located at `dist/scripts/importer/run.js`.
72
-
73
-
### Importer Arguments
74
-
75
-
The importer accepts several command-line arguments:
76
-
77
-
* `--publish`: (Default: `false`) When present, the importer will write data directly to the API's data store. If omitted, it performs a "dry run" and writes staging output to `.local/import-output`.
78
-
*`--force`: Can only be used with `--publish`. Forces the importer to overwrite existing data.
79
-
*`--only <type>`: Imports only a specific type (e.g., `characters`, `weapons`).
80
-
*`--onlyWeapons`: Shorthand to import only weapons.
81
-
*`--skipCharacters`: Skips importing characters.
82
-
*`--skipWeapons`: Skips importing weapons.
83
-
*`--delayMs <milliseconds>`: (Default: `250`) Delay between requests to external sources.
84
-
*`--concurrency <number>`: (Default: `2`) Number of concurrent requests.
***`--help` Warning:** The importer's CLI does not correctly process `--help` and will throw an "Unknown flag: --help" error.
99
-
* **`mappings.json`:** This file, located at `scripts/importer/mappings.json`, is crucial for the importer's operation. Do not move or modify it unless you understand the implications.
100
-
***Dist-Only Importer:** The importer should only be run from its compiled JavaScript output in the `dist/` directory.
101
-
102
-
## 6. Docker-Compose Deployment
68
+
69
+
## 5. Docker-Compose Deployment
103
70
104
71
The `wuwa-api` can be deployed using Docker-Compose. The official Docker image is `ghcr.io/projektcode/wuwa-api:main` (note the lowercase).
105
72
@@ -112,6 +79,6 @@ To use with Docker-Compose:
112
79
docker compose up -d
113
80
```
114
81
115
-
## 7. Configuration
82
+
## 6. Configuration
116
83
117
-
Environment variables can be used to configure the API. Refer to the `.env.example` file in the project root for available options.
84
+
Environment variables can be used to configure the API. Refer to the `.env.example` file in the project root for available options.
0 commit comments