From 3f7a862cc554cc3ec86f34fabf6f95b17078c270 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Krop=C3=A1=C4=8Dek?= Date: Sun, 17 Nov 2024 23:44:40 +0100 Subject: [PATCH] readme --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..7b16461 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# secret-santa +``` +Santa or satan? πŸŽ…πŸΏπŸ‘Ή +``` +This is a simple but very over-engineered secret santa manager web application written in go + +Why? Because I can. And because I wanted to learn how to write a web application in go. + +## Features + - [x] Web server is up and running + - [x] Basic API routes + - [x] Database migrations (only for sqlite) + - [ ] Configurable database connection + - [ ] Automatic database migrations (will be probably only supported for Docker deployments or with a guide) + - [ ] Tests + - [ ] Frontend using templates + - [ ] Authentication middleware + +## Used technologies + - [Go](https://go.dev/) + - [SQLc](https://sqlc.dev/) + - [SQL-Migrate](https://github.com/rubenv/sql-migrate)