docs: readme

2024-12-06 19:16:34 +01:00 · 2023-05-24 14:10:41 -04:00
parent 4b8e816afe
commit 145e2af70f
1 changed files with 14 additions and 0 deletions
@@ -0,0 +1,14 @@
+# launchpad-redirects
+
+## Development
+
+1. Install Go
+2. `go run .` in the root
+
+## Deployment (Production)
+
+1. Install Docker
+2. Copy `docker-compose.example.yml` to `docker-compose.yml`
+3. Run `docker compose up -d`
+
+It will run on 127.0.0.1:8080 by default.