Initial README

README.md

@@ -0,0 +1,17 @@
+# `kinklist.nekoapril.blog`
+
+This is the repo for my personal kink and gear lists if you would like to fork this repo for your own use feel free to do so!
+
+## Dependencies
+
+All dependencies can be managed with a nix devshell and flakes enabled. If you have nix flakes enabled, either run `nix develop` in the root directory or run `direnv allow` if you have direnv set up.
+
+If you do not have nix set up, then all that is needed is an HTTP server. The entire project is in plain HTML, CSS, and Javascript so `npm` or similar tools are not needed.
+
+## Host locally
+With nix, enter into the devshell and enter `run` in the command line, then go to `localhost:8080` (or whatever port number your server reserved).
+
+Without nix, follow the instructions for your preferred http server, hosting on the `/src/` directory for testing or `/artifacts/` after building for testing production.
+
+## Deploy
+With nix, enter into the devshell and run `build` to generate the `/artifacts/` directory and the `/bundle.zip` file, which can be sent to your server and hosted with nginx after unzipping.

flake.nix

@@ -39,6 +39,19 @@
               typescript
               nodejs_24
             ];
+
+            commands = [
+              {
+                help = "Launch HTTP server for local testing";
+                name = "run";
+                command = "http-server src -c-1";
+              }
+              {
+                help = "Build files for deployment to server";
+                name = "build";
+                command = "mkdir artifacts; cp -r src/* artifacts; ${pkgs.zip}/bin/zip -r9 bundle.zip artifacts";
+              }
+            ];
           };
         };
     };