MonityApp

Table of Contents

• Project Description
• Tech Stack
• Getting Started Locally
• Available Scripts
• Project Scope
• Project Status
• License

Project Description

MonityApp is designed to help users systematically track expenses, categorize and analyze financial habits, and visually interpret their spending patterns through an intuitive interface.

Key Features

• Subscription tracking and management
• Payment monitoring and history
• Smart notifications for renewals and payments
• Subscription analytics and insights
• User-friendly interface for subscription management

Tech Stack

Frontend

• Language: TypeScript
• Framework: React 18+
• State Management: Redux
• Routing: React Router
• Styling: Tailwind CSS
• Data Visualization: Recharts

Backend & Infrastructure

• Authentication: Supabase
• Database: Supabase

Development Tools

• Vitest for testing
• ESLint for code linting
• Prettier for code formatting
• Git for version control

Testing

• Unit Tests:
  • Vitest as the main testing framework
  • React Testing Library for component testing
• Component Tests: React Testing Library with Vitest
• E2E Tests: Playwright for end-to-end testing
• Visual Regression Tests: Storybook with Chromatic
• Test Coverage: Minimum 90% coverage for critical modules
• CI/CD Integration: Automated testing via GitHub Actions

CI/CD

• Workflow Automation: GitHub Actions

Getting Started

Prerequisites

• Node.js (latest LTS version recommended)
• npm or yarn

Installation

1. Clone the repository:

git clone https://github.com/yourusername/monityApp.git
cd monityApp

2. Install dependencies

npm install
# or
yarn install

3. Set up environment variables:

cp .env.example .env

Edit .env with your configuration values.

4. Start the development server:

npm start
# or
yarn start

Available Scripts

• npm start - Starts the Expo development server
• npm test - Runs the test suite
• npm run lint - Runs ESLint to check code quality
• npm run build - Builds the app for production
• npm run eject - Ejects from Expo (one-way operation)

Project Scope

MVP Features

• User authentication and profile management
• Subscription tracking and management
• Payment monitoring and history
• Basic notification system
• Subscription analytics dashboard

Future Development

• Advanced analytics and reporting
• Subscription recommendations
• Budget tracking and management
• Multi-currency support
• Export and backup functionality

Project Status

Monity is currently in active development. The project is following an iterative development approach, with regular updates and improvements being made to enhance functionality and user experience.

Current Status

• Core features are being implemented
• Basic infrastructure is in place
• Authentication system is operational
• Database schema is established

Known Issues

• Some features are still in development
• Performance optimizations are ongoing
• UI/UX improvements are being implemented

License

This project is licensed under the MIT License - see the LICENSE file for details.