diff --git a/readme.md b/readme.md index c0a051c..ac49507 100644 --- a/readme.md +++ b/readme.md @@ -1,3 +1,9 @@ +# Sample Webapplication in Go +Sample Webapplication in go, create a kind of skeleton for monolith webapplicaion. Useed to create a small MVP Project. + +## Structur +Create (self contained) pkg for a group of pages. The pkg included the View and Go files for the Pages e.g. user pages. + ## Including Packages * https://github.com/go-chi/chi -> Routing and middelware @@ -5,6 +11,25 @@ * https://github.com/golang-migrate/migrate -> for mysql migration * https://github.com/urfave/cli -> for cli commands like migration +# Features + +## Global Layout +The "globale layout" is put arround each response from a pkg web response. It read the response buffer from and use the content to parse the layout.tmpl. It works via middelware + +## JWT-Auth +*todo* + +## Migrations +Its possitlbe to execute the migrations via `go run ./ migrate`. It execute the migration files in database/migrations/*.sql + +## One Binary +Everything (include templaes and migration) can be added in one binary + +## Make commands +*todo* + +# Dev + Test für das entwickeln von Monolith webanwendung mit html gui in go. @@ -15,7 +40,7 @@ Das layout gibt es einmal zentral und wird per chi middelware reingereicht. Alles ist in einem binary -next steps: +# next steps * conifg per env * makefile * ci/Cd bis docker image bauen \ No newline at end of file