Sqrtledger-core NPM

About The Project

There are many great README templates available on GitHub; however, I didn't find one that really suited my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.

Here's why:

Your time should be focused on creating something amazing. A project that solves a problem and helps others
You shouldn't be doing the same tasks over and over like creating a README from scratch
You should implement DRY principles to the rest of your life :smile:

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this template!

Use the BLANK_README.md to get started.

Built With

Getting Started

Installation

Use npm to install Sqrt Ledger Core:

npm

npm install sqrtledger-core@latest -- save

Usage

import {
  MongoDbAccountRepository,
  MongoDbTransactionRepository,
  TransactionService,
  IAccountRepository,
} from 'sqrtledger-core';

const accountRepository: IAccountRepository = new MongoDbAccountRepository(null);
const transactionRepository: ITransactionRepository = new MongoDbTransactionRepository(null);

const transactionService: TransactionService = new TransactionService(
  accountRepository,
  transactionRepository
);

Models

Account View

{
  "label": "All In One Current Account",
  "metadata": {
    "issuer": "Banco Santander"
  },
  "name": "Current Account",
  "reference": "EVoiVSfB"
}

Account

{
  "availableBalance": 10000,
  "balance": 10000,
  "label": "All In One Current Account",
  "metadata": {
    "issuer": "Banco Santander"
  },
  "name": "Current Account",
  "reference": "EVoiVSfB",
  "settings": {
    "allowTransactions": true,
    "allowCreditTransactions": true,
    "allowDebitTransactions": true
  },
  "status": "active"
}

Card

{
  "authorizationCode": "AUTH_gltaab334m",
  "bankIdentificationNumber": "408408",
  "expirationMonth": "12",
  "expirationYear": "2030",
  "last4Digits": "4081"
}

Roadmap

Account Service
- Implement create Function
- Implement delete Function
- Implement find Function
Customer Service
- Implement create Function
- Implement createOrUpdate Function
- Implement find Function
- Implement findAll Function
Transaction Service
- Implement complete Function
- Implement create Function
- Implement createProcessComplete Function
- Implement createProcessCompleteMultiple Function
- Implement fail Function
- Implement find Function
- Implement findAll Function
- Implement process Function
Account Repository using MongoDB
- Implement create Function
- Implement delete Function
- Implement find Function
- Implement updateAvailableBalance Function
- Implement updateBalance Function
Account Repository using Redis
- Implement create Function
- Implement delete Function
- Implement find Function
- Implement updateAvailableBalance Function
- Implement updateBalance Function

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!