PocketPlan - Personal and family finance tool

Table of Contents

• PocketPlan - Personal and family finance tool
  • Table of Contents
  • Introduction
  • Features
  • Tech Stack
  • Getting Started
    • Prerequisites
    • Installation
    • Folder Structure
  • Other links
  • Contributing
  • License
  • Contact

Introduction

Welcome to PocketPlan, a mobile app designed to help you manage your personal and family finances easily and efficiently. With PocketPlan, you can track your income and expenses, set up budgets and financial goals, and maintain control of your finances with detailed reports.

Features

• Personal and family finance management
• Income and expense tracking
• Custom budget setup
• Detailed and graphical reports
• Cross-platform support (iOS and Android)
• Payment reminders and financial goal tracking
• Multi-user support for family management

Tech Stack

• React Native: For building native UI on IOS and Android.
• Expo: For quick multi-platform project management and deployment.
• Zustand: For global state management.
• Clerk: For authentication
• React Navigation: For in-app navigation
• Nativewind: For styling

Getting Started

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js (v16.x or later)
• Expo CLI (latest version)
• npm or yarn
• Git

Installation

1. Clone the repository:

   git clone https://github.com/Duccem/ducen-finance-app.git
   cd ducen-finance-app

2. Install dependencies:

   npm install
   # or
   yarn install

3. Set up environment variables:

   Create a .env file in the root directory and add the following variables:

   EXPO_PUBLIC_CLERK_PUBLISHABLE_KEY=clerk-publishable-key
   EXPO_PUBLIC_STRIPE_PUBLISHABLE_KEY=stripe-publishable-key
   EXPO_PUBLIC_SERVER_BASE_URL=https://localhost:3000

4. Run the development server:

   npm start
   # or
   yarn start

5. Scan the QR code using the Expo Go app on your mobile device (available on App Store and Google Play).

Folder Structure

ducen-finance-app/                        
├── src/                             # Project main folder
│   ├── app/                         # Expo app router 
│   ├── libs/                        # Aux libraries
│   │   ├── ui/                      # Custom own ui library
│   │   └── utils/                   # Utility functions
│   ├── modules/                     # Modules of DDD source code
│   │   ├── shared/                  # Shared modules across all apps                
│   │   └── [subdomain]/             # Correspondent module to a subdomain
│   ├── assets/                      
├── .env.example                
├── .eslintrc.js
├── .gitignore     
├── .prettierrc     
├── app.json     
├── babel.config.js     
├── expo-env.d.ts       
├── tailwind.config.ts     
├── tsconfig.ts     
├── README.md    
├── package.json     
└── index.js                          # Entry point of the app

Other links

• Changelog

Contributing

• José Véliz (Duccem)

License

This project is licensed under the MIT License.

License

Contact

For any questions or inquiries, please contact us at ducen29@gmail.com.