shoshinnikita / budget-manager Goto Github PK

• I've tried the README way.
  • In which I was getting database init error: couldn't create DB connection: database is down error.
• Hence, I have build the project using docker-compose up --build and I was able to start the server.
  • But later on the browser I got 404 error.

PostgreSQL is an overkill for this project because we don't need complex relationships and high performance. Yet we have to run DB in a Docker container (it can be very annoying).

It makes sense to use an embed storage instead. Possible options:

• github.com/etcd-io/bbolt
• github.com/asdine/storm
• github.com/dgraph-io/badger
• SQLite with a driver that doesn't require CGO

Note: The migration must not affect API

Add special error types for internal/db package:

• BadRequestErrorType - error caused by invalid request data (empty id)
• InternalErrorType - error caused by internal error (db error)

Auto convert commas to points in the entered numbers: 35,5 -> 35.5

We should use Global Configuration to avoid option repeating

3.x Migration Guide

Use mocks for tests in internal/web package instead of real DB connection. It will let us run tests without a PostgreSQL instance.

We can use github.com/golang/mock package for mocking

There are tests for the most of DB methods. But some methods don't have even indirect tests. It is needed to add checks for these methods:

• GetDay
• GetDayIDByDate
• GetMonthID

• Default value can be NULL or 0 (no value). Another option is to use 1 by default.
• Value can be rational: 0.152, 3, 1.75 and etc. The maximum precision is 0.0001. We can store it as v*1000 (like money)
• We can display price (use different name?) next to the cost. Price would be cost / amount. If amount is undefined, price would be -
• We have to display a lot of data on Month page. So, we can show price only on Search & Statistics page

User should be able to edit type and (maybe) date

Add an info block with the current version and the hash commit. Also specify a link to the GitHub repo

Add unit tests for function db/pg.recomputeMonth

• Add field ParentID into Spend Type structure
• Update API and UI to create and edit Spend Types
• Update search UI: if chosen Spend Type has children, chose them too

Display the total cost of daily spends before the saldo:

• Add project description
• Add Setup section (docker-compose.yaml example and etc.)
• Add screenshots

• Review all scripts and update or remove outdated ones
• Remove directory /tools:
  • fill_db.go is barely used. It is easier to init the db manually
  • api.rest is meaningless because there's swagger.yml that can be used to make requests
  • bench.sh also doesn't make much sense because it is difficult to reproduce the results

• Remove tests in package db/pg
• Update tests in package web, but don't replace them with unit tests (#59)
• Use the latest version of github.com/vektra/mockery for mock generation
• ? Move tests from package web to a special package

Trim spaces in titles, notes and etc.

Format links in Notes section:

• trim them to N characters
• highlight them

1. Update API

   GET /api/search
   Content-Type: application/json
   Authorization: Basic ...
   

   {
     "title": "foo"   # title pattern (contains)
     "notes": "sales" # notes pattern (contains)
   
     "after":  "2006-01-02T15:04:05Z07:00" # start date to search (`RFC3339` layout)
     "before": "2006-01-02T15:04:05Z07:00" # end date to search (`RFC3339` layout)
   
     "min_cost": "15.5" # minimal Spend Cost
     "max_cost": "27.3" # maximal Spend Cost
   
     "type_ids": "1,2,55" # list of Spend Type ids separated by comma
   }

2. Add a page with url /search. It supports all params from API but consumes them from query parameters