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: README.md
+28-14Lines changed: 28 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,14 +26,27 @@ The Satisfactory Mod Repository backend API - a Go-based service providing REST
26
26
27
27
If you are on Windows, due to a bug in [mise and aqua](https://github.com/aquaproj/aqua-registry/pull/42498/), you will also need to do the following:
28
28
29
+
<!-- TODO make a mise task that does this for you -->
29
30
```ps1
30
31
> mise where aqua:minio/mc
31
32
<some folder path>
32
33
# Go to the folder
33
34
# Rename the `mc` file to give it an extension: `mc.exe`
34
35
```
35
36
36
-
2. Start Development Services
37
+
2. (First Time Setup Only) Set up the Configuration File
38
+
39
+
First, start the containers so you can generate some of the required configuration tokens:
40
+
41
+
```bash
42
+
# If this command fails, ensure you have Docker running and configured correctly
43
+
mise run setup
44
+
```
45
+
46
+
Next, create a copy of `config.sample.json` as `config.json` and fill in the required fields.
47
+
See the [Configuration](#configuration) section for details.
48
+
49
+
3. Start Development Services
37
50
38
51
```bash
39
52
# If this command fails, ensure you have Docker running and configured correctly
@@ -44,17 +57,14 @@ The Satisfactory Mod Repository backend API - a Go-based service providing REST
44
57
mise run api
45
58
```
46
59
60
+
If the first line of the output contains `config initialized using defaults and environment only!` then ensure your config file is formatted correctly and does not include `//` comments.
61
+
47
62
If running `api` produces errors about the database failing to apply migrations,
48
63
you may have switched branches without cleaning up after database changes you were working on.
49
64
The easiest way to get back from this state
50
65
is to delete the `postgres` Docker container
51
66
and delete all not-in-use volumes so it creates a fresh one.
52
67
53
-
3. Set up the Configuration File
54
-
55
-
Create a copy of `config.sample.json` as `config.json` and fill in the required fields.
56
-
See the [Configuration](#configuration) section for details.
57
-
58
68
## Development Commands
59
69
60
70
```bash
@@ -150,22 +160,26 @@ Doing this requires manually creating a `user_groups` entry for you user.
150
160
- Generated code in `generated/`
151
161
- Database schemas in `db/schema/`
152
162
153
-
## Configuration
154
-
155
-
Create `config.json`, or use environment variables with `REPO_` prefix.
4.**OAuth providers** - GitHub, Google, Facebook. For testing purposes, [setting up just GitHub](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) is the easiest.
164
-
5.**PASETO keys** - Generate these with `go run cmd/paseto/main.go`
165
-
6.**VirusTotal API key** - For mod scanning. Optional for testing.
168
+
4.**VirusTotal** - External API for mod scanning. Optional for testing and local development.
169
+
170
+
## Configuration
166
171
167
172
**Development services** are started automatically with `mise run setup`. MinIO configuration is included in the setup task.
168
173
174
+
Create `config.json`, or use environment variables with `REPO_` prefix.
175
+
A sample is provided: `config.sample.json`.
176
+
177
+
**For local development, you should change:**
178
+
179
+
1.**OAuth providers** - For testing purposes, [setting up just GitHub](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) is the easiest.
180
+
2.**PASETO keys** - Generate these with `mise run make_paseto_keys`
181
+
3.**VirusTotal API key** - If you want to test the mod scanning features (optional).
182
+
169
183
See `config/config.go` for full configuration structure.
0 commit comments