From 24e097c8b4f97133e01561a2196818b9ec42d951 Mon Sep 17 00:00:00 2001 From: matty Date: Sat, 14 Feb 2026 00:14:05 +0000 Subject: [PATCH] update readme --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 42 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f9931ac..31dc4b4 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,52 @@ Useful for people who can't be fucked to just search for it on [GunCAD Index](https://guncadindex.com). +### How It Works + +1. Go to the site and type a search query +2. Click **Search on GCI** for a direct search, or **I'm feeling free** for a random result +3. Copy the generated link and send it to whoever needs to learn how to use a search bar +4. When they open the link, a fake cursor animates across the screen, types the query into the search box, clicks the button, and redirects them to GunCAD Index with a snarky "Was that so hard?" toast + ### Development ```bash +npm install npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev ``` Development server opens on [localhost:5000](http://localhost:5000) + +### Deployment + +#### Build + +```bash +npm install +npm run build +``` + +#### systemd + +Copy the service file and start it: + +```bash +cp lmgcitfy.service /etc/systemd/system/ +systemctl daemon-reload +systemctl enable --now lmgcitfy +``` + +The service expects the app to be located at `/opt/lmgcitfy` and runs as `www-data`. Adjust `WorkingDirectory` and `User`/`Group` in the service file as needed. + +#### NGINX + +Copy the config and enable it: + +```bash +cp lmgcitfy.nginx.conf /etc/nginx/sites-available/lmgcitfy +ln -s /etc/nginx/sites-available/lmgcitfy /etc/nginx/sites-enabled/ +nginx -t +systemctl reload nginx +``` + +Replace `example.com` in the config with your domain. SSL certificates are expected at the default certbot paths — run `certbot --nginx -d yourdomain.com` if you need to generate them.