Categorygithub.com/smallbatch-apps/earnsmart-api
modulepackage
0.0.0-20241120013354-c0baa671bb57
Repository: https://github.com/smallbatch-apps/earnsmart-api.git
Documentation: pkg.go.dev

# README

earnsmart-api

API for EarnSmart, a financial services investment platform powered by Golang, Tigerbeetle and PostgreSQL. It is intended to form a base for a fully featured application that adds additional business rules and requirements onto the existing scaffold. The application as developed is by-design minimal in requirements. Questions such as fee schedules, KYC, and other business rules are not yet implemented, because they are highly dependent on the specific use-case and business model.

Near infinite additional functionality can be added to the base scaffold, and the application is designed to allow for such additions.

About Tigerbeetle

Tigerbeetle is a high performance, ultra-high availability database solution for financial transactions. Tigerbeetle handles all user account management, balances, and book-keeping for EarnSmart.

Current feature set

At present features are being aggressively added, and nothing is fully completed, though price listings should be correct. With that said the worker to update prices is not yet implemented, and the API is not yet fully functional.

This list will be updated as features are added.

  • logging middleware
  • admin middleware
  • user middleware
  • CORS and heading middleware
  • User login
  • User logout
  • User session
  • User password reset
  • Price listings
  • Activity logging
  • Model creation and database structure
  • Database migration
  • Fund routing
  • Fund service functionality
  • Account generation and searching
  • Transfer/transaction model implementation
  • Worker to update prices
  • Worker to handle payouts on investments
  • Worker to handle matured divestment
  • User registration
  • Initial database seeding
  • User account management
  • User investment and divestment routes
  • RFQ routing and functionality
  • Swap routing and functionality
  • Role Based Access Control - RBAC
  • Crypto management and wallet generation

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author