From 4460ad280f1d183d57f4f30b76576fb060fc83c1 Mon Sep 17 00:00:00 2001 From: Ian Meyer Date: Mon, 14 Oct 2024 15:08:21 -0400 Subject: [PATCH] Update README.md (#66) Change-Id: Ib81a6acbf71600c2e07394edac7f84f56af255b2 Signed-off-by: Ian Meyer --- README.md | 28 +++++++++++++--------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index a320104..7f52fce 100644 --- a/README.md +++ b/README.md @@ -3,27 +3,25 @@ Discussion board for your tailnet ## Why? -Why not? Who doesn't want a discussion board for their tailnet? Honestly, I've often found myself wanting a small/simple/easy-to-deploy discussion board [a la pgBoard](https://github.com/pgBoard/pgBoard). The apps [golink](https://github.com/tailscale/golink) and [tclip](https://github.com/tailscale-dev/tclip) use the tailscale go library to expose the application securely on your tailnet. I thought this was a good fit for what I'm calling `tdiscuss`. That's why. Well, and it's fun! +Why not? Who doesn't want a discussion board for their tailnet? (sarcasm) .. Honestly, I've often found myself wanting a small/simple/easy-to-deploy discussion board [a la pgBoard](https://github.com/pgBoard/pgBoard). The apps [golink](https://github.com/tailscale/golink) and [tclip](https://github.com/tailscale-dev/tclip) use the tailscale go library to expose the application securely on your tailnet. I thought this was a good fit for what I'm calling `tdiscuss`. That's why. Well, and it's fun! ## Building -Install [bazelisk](https://github.com/bazelbuild/bazelisk), then see what platforms exist to build for: `bazelisk query //...` .. any of the `:tdiscuss-{linux,darwin}-{amd,arm}64` are targets. +1. Install [bazelisk](https://github.com/bazelbuild/bazelisk) +1. `make` will run tests and build -1. `bazelisk build --stamp --workspace_status_command="${PWD}/status.sh" //:tdiscuss-linux-amd64` - -## Running +## Running for development 1. Be a [tailscale](https://tailscale.com) user 1. Have an [auth key](https://login.tailscale.com/admin/settings/keys) created for the last step in this list. 1. Set up a PostgreSQL database version 14+ 1. `psql < sqlc/schema.sql` -2. `DATABASE_URL= TS_AUTHKEY=` - -Success looks like -``` -{ - "time": "2024-07-07T19:49:37.305788-07:00", - "level": "INFO", - "msg": "AuthLoop: state is Running; done" -} -``` +2. `DATABASE_URL= TS_AUTHKEY= make run-binary` + +## Running for production + +Coming soon... + +## Issues + +Issues building or running? General questions? File an issue!