first commit

README.md

@@ -0,0 +1,28 @@
+# Go boilerplate project
+
+### A straightforward Go boilerplate project equipped with essential definitions to kickstart your project.
+
+## How to run the application
+1 - Copy the .env.dist to .env (you can edit the values if you want)
+
+`$ cp .env.dist .env`
+
+2 - Run make command, it will show the list of commands we have to make easier to start the application.
+
+`$ make`
+
+3 - Start the application
+
+`$ make setup-local`
+
+4 - Run the tests
+
+`$ make tests`
+
+5 - Run the lint
+
+`$ make lint`
+
+6 - Run all the validations (lint + tests)
+
+`$ make validation`