Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 

Repository files navigation

CashPilot

CashPilot is a mobile app that automates personal finance management by splitting users' paychecks into key categories such as debts, bills, savings, and investments. The app securely links to users' bank accounts via the Plaid API, tracks transactions in real-time, and allocates funds according to preset financial goals. CashFlow helps users manage cash flow, track bills, automate debt payments, and provides a clear financial overview through detailed reports and visualizations.

Table of Contents

Features

  • Paycheck Allocation: Automatically divides income into debts, bills, savings, and investments based on user-defined goals.
  • Bill & Debt Management: Tracks bills and debts, offering reminders and automated payments.
  • Financial Reports: Provides interactive charts and real-time reports on budgets, savings, and debt progress.
  • Real-Time Notifications: Alerts users on upcoming bills, payments, and financial milestones.
  • Secure Authentication: Protects sensitive financial data with OAuth 2.0 and two-factor authentication (2FA).

Tech Stack

Front-End

  • React Native: For building a cross-platform mobile application on iOS and Android.
  • TypeScript: For type safety and improved developer experience.
  • Redux Toolkit: For managing complex state such as user accounts, transaction history, and financial reports.
  • React Navigation: For managing navigation and routing within the app.
  • D3.js or Recharts: For creating interactive and insightful financial charts and visualizations.

Back-End

  • Go with Gin: For high-performance server-side API and routing.
  • PostgreSQL with GORM: For relational data management, handling transactions, and complex queries.
  • Plaid API: For secure bank account linking and real-time transaction monitoring.
  • Redis: For caching frequent queries and improving the speed of real-time features like notifications.

API Integration

  • Plaid API: For securely connecting to users' bank accounts and tracking transactions.
  • Stripe or PayPal: For handling direct payment processing or subscriptions if needed.

Notifications

  • Firebase Cloud Messaging (FCM): For real-time push notifications on upcoming bills and payment reminders.

CI/CD and Deployment

  • GitHub Actions: For automated testing, building, and deployment pipelines.
  • Docker: For containerizing the backend services for consistency across environments.
  • AWS:
    • Elastic Beanstalk: For scalable deployment and auto-scaling of the backend.
    • RDS (Relational Database Service): For managing the PostgreSQL database.
    • S3: For secure storage of user-generated content, such as reports.

Security

  • AWS KMS or Vault: For managing sensitive data encryption keys.
  • Helmet and Rate Limiting: For securing API endpoints against common attacks (e.g., SQL Injection, DDoS).
  • OAuth 2.0: For secure user authentication and social login integration (Google/Apple).

Testing

  • Jest: For unit and integration testing on the front-end.
  • Go Test Suite: For testing the backend APIs.
  • Cypress: For end-to-end testing across user workflows.
  • React Native Testing Library: For front-end component testing.

Usage

  1. Link Bank Account: Securely link your bank account via Plaid to start tracking your transactions.
  2. Set Financial Goals: Define how you want your income to be allocated across debts, bills, savings, and investments.
  3. Manage Bills: Track your bills and debts, set reminders, and automate payments.
  4. Monitor Finances: Use interactive dashboards to view your financial health and track progress towards your goals.
  5. Receive Notifications: Get real-time alerts on upcoming bills, payments, and financial milestones.

License

CashFlow is licensed under the MIT License. See the LICENSE file for more details.

Contact

Alexis San Javier - ucfknight2017@gmail.com

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors