init project

README.md

@@ -0,0 +1,64 @@
+<h1 align="center">
+    <img height="80" width="160" src="./assets/gopher-icon.gif" alt="Go"><br>Backend Template
+</h1>
+
+> Clean architecture based backend template in Go.
+
+## Makefile
+
+Makefile requires installed dependecies:
+* [go](https://go.dev/doc/install)
+* [docker-compose](https://docs.docker.com/compose/reference)
+* [migrate](https://github.com/golang-migrate/migrate)
+
+
+```shell
+$ make
+
+Usage: make [command]
+
+Commands:
+ rename-project name={name}    Rename project
+ 
+ build-http                    Build http server
+
+ migration-create name={name}  Create migration
+ migration-up                  Up migrations
+ migration-down                Down last migration
+
+ docker-up                     Up docker services
+ docker-down                   Down docker services
+
+ fmt                           Format source code
+ test                          Run unit tests
+
+```
+
+## HTTP Server
+
+```shell
+$ ./bin/http-server --help
+
+Usage: http-server
+
+Flags:
+  -h, --help               Show mycontext-sensitive help.
+      --env-path=STRING    Path to env config file
+```
+
+**Configuration** is based on the environment variables. See [.env.template](.env).
+
+```shell
+# Expose env vars before and start server
+$ ./bin/http-server
+
+# Expose env vars from the file and start server
+$ ./bin/http-server --env-path ./config/env/.env
+```
+
+## API Docs
+* [furtuna Backend](https://furtuna-be.app-dev.altru.id/docs/index.html#/)
+
+## License
+
+This project is licensed under the [MIT License](https://github.com/pvarentsov/furtuna-be/blob/main/LICENSE).