this repo has no description
Clarify CONTRIBUTING local setup
+15
-9
+15
-9
CONTRIBUTING.md
+15
-9
CONTRIBUTING.md
···
62
62
63
63
## Local setup
64
64
65
-
Environment is configured via environment variables. For development, the server prefers a `.env` file in your instance folder: `$LUMINAFOLDER/.env`.
65
+
Local setup is pretty easy with mise, and to not do it with mise is actually kind of unthinkable for me at this point.
66
66
67
-
Key variables (defaults exist for development):
68
-
- `LUMINA_DB_TYPE` — `sqlite` or `postgres` (default: `sqlite`)
69
-
- `LUMINA_REDIS_URL` — `redis://127.0.0.1/`
70
-
- `LUMINA_SERVER_ADDR` — `127.0.0.1`
71
-
- `LUMINA_SERVER_PORT` — `8085`
72
-
- And others described in `README.MD`
67
+
Typical preparation:
68
+
```sh
69
+
# From repo root
70
+
mise install
71
+
mise run build-env-image-podman # Build the environment image for podman, allowing you to build quicker.
72
+
# And then later:
73
+
mise run development-run-podman
74
+
```
73
75
74
-
First-time setup:
76
+
Running bare-metal is usually prepared:
77
+
75
78
```sh
76
79
# From repo root
77
80
mise install
78
-
mise run build-server
81
+
mise run development-run-redis # Because you'll need a Redis server running locally.
82
+
# And then later:
83
+
mise run development-run
79
84
```
85
+
The README should have some environment variables you could set.
80
86
81
87
Development run options:
82
88
```sh