From bceadfe7a68b504948fa93d7801b3e3966cd4c61 Mon Sep 17 00:00:00 2001 From: phoenix Date: Sat, 30 May 2026 23:04:00 -0400 Subject: [PATCH] Blank readme --- README.md | 29 ----------------------------- 1 file changed, 29 deletions(-) diff --git a/README.md b/README.md index 1917a61..8b13789 100644 --- a/README.md +++ b/README.md @@ -1,30 +1 @@ -# textsender-auth -A service that handles the authorization aspect of the textsender project. - -## Getting started -Assumes that the postgresql database has already been created with privileges to -create and drop databases. Copy the `.env.sample` file to `.env`. Within the `.env` -file, update the database keys. The `SECRET_KEY` is used for token generation. - - -### Building api -``` -make build -``` - - -### Resetting the database -``` -./textsender-auth -reset-db -``` - - -Generate API documentation -``` -go install github.com/swaggo/swag/cmd/swag@latest - -swag init --generalInfo main.go --dir ./cmd/api,./internal/handler --output docs/ --parseDependency --parseInternal -``` - -The API documentation can be viewed from `http://localhost:9080/swagger/index.html`.