An open API service indexing awesome lists of open source software.

https://github.com/techprimers/spent

Open Source Project for tracking all your spends based on your Bank Statements
https://github.com/techprimers/spent

architecture bank-statements collaboration open-source

Last synced: over 1 year ago
JSON representation

Open Source Project for tracking all your spends based on your Bank Statements

Awesome Lists containing this project

README

          

spent logo

[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)
[![Build Status](https://travis-ci.com/TechPrimers/spent.svg?branch=master)](https://travis-ci.com/TechPrimers/spent)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ddac01ec34cd4c41a2bbed7505953736)](https://www.codacy.com/app/MovingToWeb/spent?utm_source=github.com&utm_medium=referral&utm_content=TechPrimers/spent&utm_campaign=Badge_Grade)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
[![GitHub issues](https://img.shields.io/github/issues/techprimers/spent.svg)](https://github.com/techprimers/spent/issues)
[![GitHub issues closed](https://img.shields.io/github/issues-closed-raw/techprimers/spent.svg?maxAge=2592000)]()
[![GitHub forks](https://img.shields.io/github/forks/techprimers/spent.svg)](https://github.com/techprimers/spent/network)

# Open Source Project for tracking all your spends based on your Bank Statements
In India, we have so many banks and with the movement of Digital Banks and Wallets, we don't have a way to reconcile our income, spend and savings. The idea of this project is to create a personalized way to track your spend to identify how much you **spent** based on your bank statements and bank messages.

Table of Contents
=================

* [Features](#features)
* [Upcoming](#upcoming)
* [Collaboration with developers](#collaboration-with-developers)
* [Structure](#structure)
* [Architecture](#architecture)
* [Microservices Patterns](#microservices-patterns)
* [Flow](#flow)
* [Start UI](#start-ui)

Created by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)

## Features

## Upcoming
- Read SBI Bank Statements in CSV format
- Read HDFC Bank Statements in CSV format
- Read Citi Bank Statements in CSV format
- Read Kotak Mahindra Bank Statements in CSV format

## Collaboration with Developers
We engage with Contributors on FindCollabs - https://findcollabs.com/project/OVxt6oPQEhx1VpvygD7G

## Structure
- `spent-react-ui` - UI for the Spent Dashboard
- `spent-kotlin-server` - Kotlin based server for processing files and transforming them into a generic model
- `spent-server` - Micronaut based server which extracts, transforms and loads into a local postgresql database

## Architecture
### Microservices Patterns
- Event Sourcing and CQRS. Reference eg:- [Eventuate Kanban board](https://github.com/eventuate-examples/es-kanban-board)

### Flow
architecture

## Start UI
- Start the React UI using the following command
```
cd spent-react-ui
npm start
npm install
```