Skip to content

README.md

Latest commit

 

History

History
107 lines (76 loc) · 3.03 KB

README.md

File metadata and controls

107 lines (76 loc) · 3.03 KB
Raw

💰 SP.End - Personal Finance Simplified

SP.End is a modern, high-performance personal finance management application designed to give you absolute control over your spending habits with a premium, immersive user experience.

Latest Release

✨ Key Features

  • 🚀 Smart Dashboard: Real-time spending analytics and budget utilization at a glance.
  • 📊 Interactive Analytics: Beautifully crafted charts powered by Recharts to visualize your financial trends.
  • 🎯 Goal Management: Set, track, and achieve your financial milestones with progress visualization.
  • 🏆 Rewards System: Gamified spending habits—earn badges as you improve your financial health.
  • 📱 Mobile-First Design: A premium immersive experience with a modern Floating Navbar and full Android support via Capacitor.
  • 🌓 Adaptive UI: Intelligent Dark and Light modes that respect your preference across web and mobile.
  • ⚡ Real-time Sync: Powered by Supabase for instantaneous data persistence and security.

🛠️ Technology Stack

  • Frontend: React 18, TypeScript, Vite
  • Styling: Tailwind CSS, Lucide Icons
  • Backend/Database: Supabase
  • Mobile Foundation: Capacitor (Android native integration)
  • Charts: Recharts
  • Native Bridges: @capacitor/status-bar, @capacitor/app, @capacitor/haptics

🚀 Getting Started

Prerequisites

  • Node.js (v18+)
  • npm or yarn
  • Android Studio (for native Android testing)

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/sp-end.git
cd sp-end

  2. Install dependencies:

    npm install

  3. Set up environment variables: Create a .env file in the root and add your Supabase credentials:

    VITE_SUPABASE_URL=your_supabase_url
VITE_SUPABASE_ANON_KEY=your_supabase_anon_key

  4. Run locally:

    npm run dev

📱 Mobile Deployment (Android)

To run SP.End on your Android device:

  1. Build the web project:

    npm run build

  2. Sync with Capacitor:

    npx cap sync android

  3. Open in Android Studio:

    npx cap open android

🔗 Latest Release

Download the latest Android APK or view the release notes here: Download Latest Release (v0.1.1)

🌐 Landing Page

The marketing site lives in website/ — a standalone Vite + React build with a three.js/GSAP hero. It deploys to GitHub Pages automatically: https://peexr.github.io/Sp.End/

cd website
npm install
npm run dev      # http://localhost:5174

Developed with ❤️ by Adarsh and Debojeet