Skip to content

Latest commit

 

History

History
53 lines (36 loc) · 1.76 KB

README.md

File metadata and controls

53 lines (36 loc) · 1.76 KB

Maskada API

Build Status Go Report Card Coverage Status

About

Maskada (from portuguese mascada, means money) is a simple money manager api developed in Go. It aims to perform very simple operations, to make it easier track your finances.

ROADMAP
  • ✓︎ Create transactions
  • ✓︎ List transactions
  • ✓︎︎ Create transactions with category
  • ✘ Manage transaction status like: delete/pending/done
  • ✘ Create recurring transactions

To make it simple to calculate, all transactions will belong to a type:

core.go

// Debit is a transaction which is subtracted.
Debit = 1

// Credit is a transaction which is subtracted the next month.
Credit = 2

// Income is a transaction which is summed.
Income = 3

All the calculations happen in the client side.

Architecture

The backend its inspired by the Clean Architecture design, the core business logic its encapsulated in the core package through Use Cases, the Use Cases communicate with the external world by well-defined interfaces, that are implemented by the clients.

Documentation

To learn more, checkout the Wiki:

Contributing

Currently, this project is mostly for studying purposes, and it's not hosted anywhere. If you're interested in learning golang, ddd, clean architecture and tests, feel free to fork it.