diff --git a/README.md b/README.md index 2fe9faa..4ba08a6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,37 @@ -cybertron service +# Cyber tron service + +## Frontend error monitoring service + + +### How to Run + +#### Install Go +```cmd +brew install go +brew install golang-lint +``` + +#### Setup postgres +You need to set-up postgres db and create a database with name `cybertron_dev` + +#### Run local + +```cmd +make run-local +``` + + +### Final Build + +```cmd +make run-all +``` + + + + + + Important pointer - When using golang-migrate for migrations, the naming convention for migration files should be - ```202310201651_initial-migration.up.sql```