Skip to content

Latest commit

 

History

History
116 lines (61 loc) · 2.86 KB

readme.md

File metadata and controls

116 lines (61 loc) · 2.86 KB
Raw

Wallet Go

This is a simple wallet application that stores users, their wallets, and transactions between wallets. This app uses a mysql database with the schema and some data sql script inside its folders. It is also monitored with prometheus and containerized with docker.

Auth

Currently, the auth service is not implemented, you can login sending a request to the login url and it will set the default user for you.

Requirements

Go 1.18 golang.org

Initial Config

Set Environment Variables

export GO111MODULE=on
export GOFLAGS=-mod=vendor

To download the app correctly you must run:

go get github.com/hoxito/walletgo

Once downloaded you will have the code in folder

cd $GOPATH/src/github.com/hoxito/walletgo

Or you could just run

https://github.com/hoxito/walletgo.git

To have the repository

Installation

To install the application in your local machine:

1- Install required libs

go mod download
go mod vendor

2- build and execution

go install
walletgo

NOTE: to run the application in development and with docker containers you must add the .env file with the following content:

in walletgo/.env

MYSQL_URL = "root:jose1@/wallet"

MYSQLC_LOCAL_PORT=3307

MYSQLC_ROOT_PASSWORD=jose1

MYSQLC_DOCKER_PORT=3306

MYSQLC_DATABASE=wallet

MYSQLC_USER=root

PORT=3000

GO_DOCKER_PORT=3010

GO_LOCAL_PORT=3010

SESSION_SECRET=ThisIsASecretShh

PROM_DOCKER_PORT=9090

PROM_LOCAL_PORT=9090

Mysql

Users, wallets and transactions are stored in a mysql database mysql The schema is described in the next image:

175548669-4ffcb56c-d102-4d81-bb6c-ff9d9880da58

To load the schema you must run your local instance of mysql and execute the sql file located in /walletgo/docker/mysql/schema.sql

API-DOCS

To load api docs you have to run the application and go to

(http://localhost:3010/swagger/index.html)

Run Docker Containers

If you wish to run the application in docker containers you can do so creating the .env file mentioned in the "installation" section and running:

cd /walletgo
docker-compose build
docker-compose up

This will create 3 docker images with their respective containers and run the containers. This containers are Mysqlc, golangApp and PrometheusAPI.

Instrumentation

To get the aplication scrapped metrics you can start the prometheus container located in walletgo/docker/prometheus/. and visit

(http://localhost:9090)

You should see the prometheus panel and interact with it. The walletgo App exposes metrics at

(http://localhost:3010/metrics)

Testing

To run tests, you must cd into the desired test folder and run

go test -v