https://github.com/mrizkisaputra/expenses-api

API RESTfull for managing expenses
https://github.com/mrizkisaputra/expenses-api

backend clean-architecture docker expenses gin-gonic golang gorm postgresql restapi webapi

Last synced: about 2 months ago
JSON representation

API RESTfull for managing expenses

• Host: GitHub
• URL: https://github.com/mrizkisaputra/expenses-api
• Owner: mrizkisaputra
• Created: 2024-10-18T09:32:58.000Z (3 months ago)
• Default Branch: master
• Last Pushed: 2024-11-27T09:47:12.000Z (2 months ago)
• Last Synced: 2024-12-04T09:32:17.163Z (about 2 months ago)
• Topics: backend, clean-architecture, docker, expenses, gin-gonic, golang, gorm, postgresql, restapi, webapi
• Language: Go
• Homepage:
• Size: 184 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Web API Expense Tracker #

This is a API RESTfull for managing expenses.

## Features

Berikut adalah fitur-fitur yang ada di **_Expense Tracker API_**:

- _Registrasi_ untuk pengguna  baru

- _Login_ untuk pengguna, hasilkan dan validasi token _JWT_ untuk menangani _authentication_ dari pengguna.

- Menambahkan pengeluaran baru

- Menghapus pengeluaran yang ada (soft delete)

- Memperbaharui pengeluaran yang ada

- pengguna dapat melihat dan memfilter daftar pengeluaran mereka berdasarkan beberapa kriteria waktu yang berbeda:

    - Minggu lalu - Filter pengeluaran yang dibuat dalam 7 hari terakhir

    - Bulan lalu - Filter pengeluaran yang dibuat dalam 30 hari terakhir

    - 3 Bulan terakhir - Filter pengeluaran yang dibuat dalam 3 bulan terakhir (90 hari)

    - Kostum - Pengguna bisa memilih sendiri rentang waktu, yaitu dengan menentukan tanggal mulai dan tanggal akhir secara manual

## Architecture Application



## Design Schema Database

![skema database](./docs/skema-database.png)

## Tech Stack

Daftar framework & library apa saja yang digunakan:

- [golang](https://go.dev/) - Programming language

- [postgreSQL](https://www.postgresql.org/docs/) - Relational database

- [redis](https://github.com/redis/go-redis) - Caching database

- [docker](https://www.docker.com/) - Docker

- [gin](https://gin-gonic.com/) - Web Framework

- [GORM](https://gorm.io/docs/index.html) -  Sql mapping object

- [uuid](https://github.com/google/uuid) - UUID

- [viper](https://github.com/spf13/viper) - configuration file

- [logrus](https://github.com/sirupsen/logrus) - Logger

- [migrate](https://github.com/golang-migrate/migrate) - Golang database migration

- [Go Playground Validator](https://github.com/go-playground/validator) - Validation

- [go jwt](https://github.com/golang-jwt/jwt) - JSON Web token

- [testify](https://github.com/stretchr/testify) - Testing toolkit

- [miniredis](https://github.com/alicebob/miniredis) - Mock redis server

- [sqlmock](https://github.com/DATA-DOG/go-sqlmock) - Mock db sql

## API Documentation

Api spec is in directory [docs](./docs)

## How to run application?

### Local development usage

    make local

    make run

### Docker development usage  

    make develop

## Run Unit Test

    # run unit-test user repository

    make user-repository-test

    # run unit-test user service/usecase

    make user-service-test

    # run unit-test user controller

    make user-controller-test

## Docker Registry

pull docker image [mrizkisaputra/expenses-api](https://hub.docker.com/r/mrizkisaputra/expenses-api)